Installation

Create your docs directory

Use the docus CLI to create a new Docus project in the docs/ directory:

npx docus init docs

We recommend using the npm package manager.

Start your docs server in development

Move to the docs/ directory and start your docs server in development mode:

npm run dev

A local preview of your documentation will be available at http://localhost:4000

Write your documentation

Head over the Edition section to learn how to write your documentation.

Create a new project on Nuxt Studio

Choose Start from a template and select Docus. Clone it on your GitHub personal account or any organisation of your choice.

Deploy in one click

Once your project has been created and you're in the project dashboard, navigate to the Deploy section, choose the GitHub Pages tab then click on the Deploy button.

Write your documentation in the editor

Once the deployment is achieved, you'll be able to display the preview of your documentation. You can browse your content pages to edit them or create new ones.