Skip to content
Back to search

docus

Write beautiful documentations with Nuxt and Markdown.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/nuxt-content/docus with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/nuxt-content/docus'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/nuxt-content--docus/badge.svg)](/listings/nuxt-content--docus)

HTML

<a href="/listings/nuxt-content--docus"><img src="/api/listings/nuxt-content--docus/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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 was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 194 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. [![docus](https://docus.dev/_og/s/o_e5724630ae944920.png)](https://docus.dev)
  2. > Create beautiful docs with Markdown & Vue components
  3. [![npm version](https://img.shields.io/npm/v/docus.svg?style=flat&colorA=020420&colorB=EEEEEE)](https://npmjs.com/package/docus)
  4. [![npm downloads](https://img.shields.io/npm/dm/docus.svg?style=flat&colorA=020420&colorB=EEEEEE)](https://npm.chart.dev/docus)
  5. [![License](https://img.shields.io/npm/l/docus.svg?style=flat&colorA=020420&colorB=EEEEEE)](https://npmjs.com/package/docus)
  6. ## 🚀 Quick Start
  7. ### Local Development
  8. Create a new documentation project in seconds:
  9. ```bash
  10. # Create a new project
  11. npx create-docus my-docs
  12. # Or create with i18n template for multi-language docs
  13. npx create-docus my-docs -t i18n
  14. # Navigate to your project
  15. cd my-docs
  16. # Start development server
  17. npm run dev
  18. ```
  19. That's it! Your documentation site will be running at `http://localhost:3000`
  20. ### Online Development
  21. Start by deploying the docus template and create your git repository directly from Vercel:
  22. [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?demo-description=Markdown-based%20documentation%20starter%20with%20Nuxt%20and%20Vue%20components.&demo-image=%2F%2Fimages.ctfassets.net%2Fe5382hct74si%2F5rLcegeMuG3ggDNfQt7rj9%2F040036056f7b30d2c99dc8998dc6b132%2Fdocus.png&demo-title=Docus&demo-url=https%3A%2F%2Fdocus.dev%2F&from=templates&project-name=Docus&repository-name=docus&repository-url=https%3A%2F%2Fgithub.com%2Fnuxt-content%2Fdocus%2Ftree%2Fmain%2F.starters%2Fdefault&skippable-integrations=1&teamSlug=vercel)
  23. ## 🎯 What it creates
  24. The CLI scaffolds a complete documentation project with:
  25. - ✨ **Beautiful Design** - Clean, modern documentation theme built on Nuxt UI 4 & Tailwind CSS 4
  26. - 📱 **Responsive** - Mobile-first responsive design
  27. - 🌙 **Dark Mode** - Built-in dark/light mode with `d` shortcut toggle
  28. - 🌍 **Internationalization** - Native i18n support with 20+ locales for assistant UI
  29. - 🔍 **Search** - Client-side search with optional FTS5 full-text search backend
  30. - 📝 **Markdown Enhanced** - Extended markdown with custom MDC components
  31. - 🎨 **Customizable** - Theme variants, custom icons,
  32. - ⚡ **Fast** - Optimized for performance with Nuxt 4
  33. - 🔧 **TypeScript** - Full TypeScript support
  34. - 🤖 **AI Assistant** - Drop-in chat that answers questions from your docs, cites sources, and generates code
  35. - 🔌 **Native MCP Server** - Built-in Model Context Protocol server for AI tool integration (Cursor, VS Code, Claude, etc.)
  36. - 📚 **Agent Skills Discovery** - Publish skills from your docs site via `.well-known/skills/`
  37. - 📄 **LLM-Ready** - Automatic `llms.txt` and `llms-full.txt` generation
  38. - 🗺️ **SEO Optimized** - Sitemap, robots.txt, and OG image generation out of the box
  39. Learn more on the [Docus documentation](https://docus.dev).
  40. ## 🤖 AI features
  41. Docus ships with a full AI stack to help both your users and contributors:
  42. ### Assistant
  43. 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](https://docus.dev/en/ai/assistant).
  44. ### MCP Server
  45. Every Docus site exposes an MCP server at `/mcp` — install it directly into your editor to query your docs from any AI tool:
  46. [![Install MCP in Cursor](https://docus.dev/mcp/badge.svg)](https://docus.dev/mcp/deeplink)
  47. [![Install MCP in VS Code](https://docus.dev/mcp/badge.svg?ide=vscode)](https://docus.dev/mcp/deeplink?ide=vscode)
  48. ### Agent Skills
  49. Drop skills into a `skills/` directory and Docus serves them at `/.well-known/skills/` following the [Cloudflare Agent Skills Discovery RFC](https://github.com/cloudflare/agent-skills-discovery-rfc). Users install them with a single command:
  50. ```bash
  51. npx skills add https://your-docs-domain.com
  52. ```
  53. Get the Docus skill itself to supercharge your AI assistant when building docs:
  54. ```bash
  55. npx skills add nuxt-content/docus
  56. ```
  57. ## 📁 Project Structure
  58. ### Generated project
  59. ```
  60. my-docs/
  61. ├── content/ # Your markdown content
  62. │ ├── index.md # Homepage
  63. │ └── docs/ # Documentation pages
  64. ├── public/ # Static assets
  65. └── package.json # Dependencies and scripts
  66. ```
  67. ### Optional files and folders
  68. Docus uses a layer system, you can go further and use any feature or file of a classical Nuxt project:
  69. ```
  70. my-docs/
  71. ├── app.config.ts # App configuration
  72. ├── nuxt.config.ts # Nuxt configuration (add extra modules, components, etc.)
  73. ├── app/ # App directory
  74. │ ├── components/ # Components (add your own components)
  75. │ ├── layouts/ # Layouts (add your own layouts)
  76. │ └── pages/ # Pages (add your own pages)
  77. └── server/ # Server-side code (add your own server-side code)
  78. ```
  79. ### `/content` folder structure
  80. **Single language structure:**
  81. ```
  82. content/
  83. ├── index.md
  84. ├── getting-started.md
  85. └── guide/
  86. ├── introduction.md
  87. └── configuration.md
  88. ```
  89. **Multi-language structure (with i18n):**
  90. ```
  91. content/
  92. ├── en/
  93. │ ├── index.md
  94. │ └── guide/
  95. │ └── introduction.md
  96. └── fr/
  97. ├── index.md
  98. └── guide/
  99. └── introduction.md
  100. ```
  101. ## ⚡ Built with
  102. Your project comes pre-configured with the best of the Nuxt ecosystem:
  103. - [Nuxt 4](https://nuxt.com) - The web framework
  104. - [Nuxt Content](https://content.nuxt.com/) - File-based CMS
  105. - [Nuxt UI 4](https://ui.nuxt.com) - UI components
  106. - [Nuxt Image](https://image.nuxt.com/) - Optimized images
  107. - [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS
  108. - [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme
  109. - [Nuxt i18n](https://i18n.nuxtjs.org/) - Internationalization
  110. - [Nuxt LLMs](https://github.com/nuxt-modules/llms) - `llms.txt` generation
  111. - [Nuxt OG Image](https://nuxtseo.com/og-image) - Open Graph image generation
  112. - [MCP Toolkit](https://mcp-toolkit.nuxt.dev) - Native MCP server
  113. - [Vercel AI SDK](https://sdk.vercel.ai) - AI assistant (optional)
  114. ## 📖 Documentation
  115. For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev)
  116. ## 🛠️ Development
  117. This repository contains the CLI tool source code.
  118. ### Local Development
  119. To contribute to the CLI tool:
  120. ```bash
  121. # Clone this repository
  122. git clone https://github.com/nuxt-content/docus
  123. # Install dependencies
  124. pnpm install
  125. # Run the dev server to run the docus docs
  126. pnpm run dev
  127. ```
  128. ### Package Structure
  129. This is a monorepo containing:
  130. - [**`/cli`**](https://github.com/nuxt-content/docus/tree/main/cli) - CLI tool (`create-docus`)
  131. - [**`/layer`**](https://github.com/nuxt-content/docus/tree/main/layer) - Docus Nuxt layer (`docus`)
  132. - [**`/docs`**](https://github.com/nuxt-content/docus/tree/main/docs) - Official documentation
  133. - [**`/.starters`**](https://github.com/nuxt-content/docus/tree/main/.starters) - Starters project
  134. ## 📄 License
  135. Published under the [MIT](LICENSE) license.
  136. ---
  137. Docus has been entirely rewritten from scratch and is inspired from [undocs](https://github.com/unjs/undocs) made by [@pi0](https://github.com/pi0) 💚

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.