Getting Started

Installation

Get started with Docus.

Local development

Create your docs directory

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

Terminal
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:

Terminal
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.

Online Edition with Nuxt Studio

Create a new project on Nuxt Studio

From your user or team dashboard, click the New project button then 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 and set your Nuxt UI Pro license (NUXT_UI_PRO_LICENSE ) in the environment variables then click on the Deploy button.

This is a one click static deployment available with GitHub Pages but you can also handle deployment yourself and use the Selfhosted tab.

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.

If you want to try Docus and Nuxt Studio in develoment mode without an UI Pro license, you can check the Nuxt Content documentation for local setup with Nuxt Studio.

Introduction

Welcome to Docus theme documentation.

Project Structure

Docus provides a ready-to-use documentation website starter.