github.com/nuxt-content/docus @v5.12.3 sqlite

Create beautiful docs with Markdown & Vue components

🚀 Quick Start

Local Development

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 dev

That's it! Your documentation site will be running at http://localhost:3000

Online Development

Start by deploying the docus template and create your git repository directly from Vercel:

🎯 What it creates

The CLI scaffolds a complete documentation project with:

• ✨ Beautiful Design - Clean, modern documentation theme built on Nuxt UI 4 & Tailwind CSS 4
• 📱 Responsive - Mobile-first responsive design
• 🌙 Dark Mode - Built-in dark/light mode with d shortcut toggle
• 🌍 Internationalization - Native i18n support with 20+ locales for assistant UI
• 🔍 Search - Client-side search with optional FTS5 full-text search backend
• 📝 Markdown Enhanced - Extended markdown with custom MDC components
• 🎨 Customizable - Theme variants, custom icons,
• ⚡ Fast - Optimized for performance with Nuxt 4
• 🔧 TypeScript - Full TypeScript support
• 🤖 AI Assistant - Drop-in chat that answers questions from your docs, cites sources, and generates code
• 🔌 Native MCP Server - Built-in Model Context Protocol server for AI tool integration (Cursor, VS Code, Claude, etc.)
• 📚 Agent Skills Discovery - Publish skills from your docs site via .well-known/skills/
• 📄 LLM-Ready - Automatic llms.txt and llms-full.txt generation
• 🗺️ SEO Optimized - Sitemap, robots.txt, and OG image generation out of the box

Learn more on the Docus documentation.

🤖 AI features

Docus ships with a full AI stack to help both your users and contributors:

Assistant

Embed an AI-powered chat in your docs that answers questions, cites sources, and generates code examples. Powered by Vercel AI Gateway and your own MCP server. See the Assistant guide.

MCP Server

Every Docus site exposes an MCP server at /mcp — install it directly into your editor to query your docs from any AI tool:

Agent Skills

Drop skills into a skills/ directory and Docus serves them at /.well-known/skills/ following the Cloudflare Agent Skills Discovery RFC. Users install them with a single command:

npx skills add https://your-docs-domain.com

Get the Docus skill itself to supercharge your AI assistant when building docs:

npx skills add nuxt-content/docus

📁 Project Structure

Generated project

my-docs/
├── content/              # Your markdown content
│   ├── index.md         # Homepage
│   └── docs/            # Documentation pages
├── public/              # Static assets
└── package.json         # Dependencies and scripts

Optional files and folders

Docus 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 structure

Single language structure:

content/
├── index.md
├── getting-started.md
└── guide/
    ├── introduction.md
    └── configuration.md

Multi-language structure (with i18n):

content/
├── en/
│   ├── index.md
│   └── guide/
│       └── introduction.md
└── fr/
    ├── index.md
    └── guide/
        └── introduction.md

⚡ Built with

Your project comes pre-configured with the best of the Nuxt ecosystem:

• Nuxt 4 - The web framework
• Nuxt Content - File-based CMS
• Nuxt UI 4 - UI components
• Nuxt Image - Optimized images
• Tailwind CSS 4 - Utility-first CSS
• Docus Layer - Documentation theme
• Nuxt i18n - Internationalization
• Nuxt LLMs - llms.txt generation
• Nuxt OG Image - Open Graph image generation
• MCP Toolkit - Native MCP server
• Vercel AI SDK - AI assistant (optional)

📖 Documentation

For detailed documentation on customizing your Docus project, visit the Docus Documentation

🛠️ Development

This repository contains the CLI tool source code.

Local Development

To contribute to the CLI tool:

# Clone this repository
git clone https://github.com/nuxt-content/docus

# Install dependencies
pnpm install

# Run the dev server to run the docus docs
pnpm run dev

Package Structure

This is a monorepo containing:

• /cli - CLI tool (create-docus)
• /layer - Docus Nuxt layer (docus)
• /docs - Official documentation
• /.starters - Starters project

📄 License

Published under the MIT license.

Docus has been entirely rewritten from scratch and is inspired from undocs made by @pi0 💚