Getting Started
Installation
Get started with Docus.
create-docus CLI
Create your docs directory
Use the create-docus CLI to create a new Docus project:
Terminal
npx create-docus my-docs
You can choose between two templates:
default: Basic Docus setup for single-language documentationi18n: Includes internationalization support for multi-language documentation
Terminal
# Create with i18n template
npx create-docus my-docs -t i18n
We recommend using the npm package manager.
Start your docs server in development
Move to your docs directory and start your docs server in development mode:
Terminal
cd my-docs
npm run dev
A local preview of your documentation will be available at http://localhost:3000
Write your documentation
Head over the Edition section to learn how to write your documentation.
Layer Integration
Docus v4 uses a Nuxt layer-based approach, you can extend the Docus layer directly in your nuxt.config.ts with extends: ['docus']:
nuxt.config.ts
export default defineNuxtConfig({
extends: ['docus']
})