dwindown/docs.tutoraddons.com
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

production ready

Browse Source
This commit is contained in:
Wildan Nursahidan
2025-04-12 18:07:10 +07:00
parent da85bc0bbf
commit ad9904d5d5
31 changed files with 115 additions and 1120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
contents/docs/getting-started/installation/index.mdx
View File

@@ -1,84 +1,30 @@
---
title: Installation
description: Installation guide for our application.
date: 17-02-2025
description: Steps for installation.
date: 12-04-2025
---
Setting up DocuBook is straightforward, with options to clone the repository or use the convenient `npx` command. DocuBook requires [Node.js](https://nodejs.org/) version 18 or higher for optimal performance.
<Note type="note" title="Note">
Before you install the TutorAddons plugin, make sure you have installed Tutor LMS first.
</Note>
## Clone Repository
To get started, you can clone the DocuBook repository directly from GitHub.
## Upload plugin
### Via Wordpress Dashboard
<Stepper>
<StepperItem title="Step 1: Clone the DocuBook Repository">
Begin by cloning the DocuBook repository from GitHub:
```bash
git clone --branch starter https://gitlab.com/mywildancloud/docubook.git
```
<StepperItem title="Step 1: Log in to Wordpress">
Login via wordpress wp-admin.
</StepperItem>
<StepperItem title="Step 2: Access the Project Directory">
After cloning, navigate into the project directory to start setting up:
```bash
cd docubook
```
<StepperItem title="Step 2: Go to Plugins">
On the WordPress dashboard page, please go to the Plugins menu.
</StepperItem>
<StepperItem title="Step 3: Install Required Dependencies">
Install all necessary project dependencies with npm:
```bash
npm install
```
<StepperItem title="Step 3: Add New Plugin">
Then select Add New Plugin.
</StepperItem>
<StepperItem title="Step 4: Launch the Development Server">
Finally, start the development server to view the project locally:
```bash
npm run dev
```
<StepperItem title="Step 4: Upload Plugin">
Click the upload plugin button then select the plugin file then click install now.
</StepperItem>
<StepperItem title="Step 5: Activate Plugin">
After the installation procedure is complete, please activate the plugin.
</StepperItem>
</Stepper>
## Quick Setup with CLI
For a faster setup, use the `cli` command to create a new DocuBook project in one step:
<Tabs defaultValue="npm" className="pt-5 pb-1">
<TabsList>
<TabsTrigger value="npm">npm</TabsTrigger>
<TabsTrigger value="pnpm">pnpm</TabsTrigger>
<TabsTrigger value="bun">bun</TabsTrigger>
<TabsTrigger value="yarn">yarn</TabsTrigger>
</TabsList>
<TabsContent value="npm">
```shell
npx @docubook/create@latest
```
</TabsContent>
<TabsContent value="pnpm">
```shell
pnpm dlx @docubook/create@latest
```
</TabsContent>
<TabsContent value="bun">
```shell
bunx @docubook/create@latest
```
</TabsContent>
<TabsContent value="yarn">
```shell
yarn dlx @docubook/create@latest
```
</TabsContent>
</Tabs>
With this setup, you’ll have a ready-to-use DocuBook instance to start building your documentation.