package
CLI for creating Docus documentation projects
npm install create-docusGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
tahul
yael.guilloux@gmail.com
The fastest way to create a new Docus documentation project. This CLI tool scaffolds a complete documentation website using the docus Nuxt layer.
Create a new documentation project in seconds:
# Create a new project
npx create-docus my-docs
# Or create with i18n template for multi-language docs
npx create-docus my-docs -t i18n
# Navigate to your project
cd my-docs
# Start development server
npm run devThat's it! Your documentation site will be running at http://localhost:3000
Creates a basic documentation project ready for single-language content.
Use the -t i18n flag to create a project with internationalization support:
npx create-docus my-docs -t i18nThe i18n template includes:
@nuxtjs/i18n modulecontent/en/, content/fr/)/en/docs, /fr/docs)The CLI scaffolds a complete documentation project with:
my-docs/
├── content/ # Your markdown content
│ ├── index.md # Homepage
│ └── docs/ # Documentation pages
├── public/ # Static assets
└── package.json # Dependencies and scriptsDocus uses a layer system, you can go further and use any feature or file of a classical Nuxt project:
my-docs/
├── app.config.ts # App configuration
├── nuxt.config.ts # Nuxt configuration (add extra modules, components, etc.)
├── app/ # App directory
│ ├── components/ # Components (add your own components)
│ ├── layouts/ # Layouts (add your own layouts)
│ └── pages/ # Pages (add your own pages)
└── server/ # Server-side code (add your own server-side code)/content folder structureSingle language structure:
content/
├── index.md
├── getting-started.md
└── guide/
├── introduction.md
└── configuration.mdMulti-language structure (with i18n):
content/
├── en/
│ ├── index.md
│ └── guide/
│ └── introduction.md
└── fr/
├── index.md
└── guide/
└── introduction.mdYour project comes pre-configured with the best of the Nuxt ecosystem:
docus - The Nuxt layer that powers your documentationFor detailed documentation on customizing your Docus project, visit the Docus Documentation
This repository contains the CLI tool source code.
To contribute to the CLI tool:
# Clone this repository
git clone https://github.com/nuxt-content/docus
# Install dependencies
pnpm install
# Build the CLI
pnpm run build
# Run the dev server to run the docus docs
pnpm run devPublished under the MIT license.