Installation
Installation guide for our application.
Setting up DocuBook is straightforward, with options to clone the repository or use the convenient npx command. DocuBook requires Node.js version 18 or higher for optimal performance.
Clone Repository
To get started, you can clone the DocuBook repository directly from GitHub.
1
Step 1: Clone the DocuBook Repository
Begin by cloning the DocuBook repository from GitHub:
git clone --branch starter https://gitlab.com/mywildancloud/docubook.git
2
Step 2: Access the Project Directory
After cloning, navigate into the project directory to start setting up:
cd docubook
3
Step 3: Install Required Dependencies
Install all necessary project dependencies with npm:
npm install
4
Step 4: Launch the Development Server
Finally, start the development server to view the project locally:
npm run dev
Quick Setup with CLI
For a faster setup, use the cli command to create a new DocuBook project in one step:
npx @docubook/create@latest
With this setup, you’ll have a ready-to-use DocuBook instance to start building your documentation.
Published on Feb 17, 2025