Repolode
Submit
nuxt-content

nuxt-content/docus

A documentation site generator built on Nuxt that lets you write docs in Markdown with Vue components.

Open-source alternative to:GitBookReadMe

View on GitHubWebsite
Stars
3,117
Forks
292
Open issues
40
Last commit
2 days ago

What is it?

Docus is a documentation framework built on Nuxt. A single CLI command scaffolds a docs project where pages are written in Markdown, optionally extended with Vue components through MDC syntax. The generated site includes a responsive theme with dark mode, client-side search, and an i18n template for multi-language docs.

Beyond the static site, Docus adds AI-oriented features. It includes an assistant chat that answers questions from the docs, a built-in MCP server at /mcp for connecting editors and AI tools, and automatic llms.txt and llms-full.txt generation. Skills placed in a skills directory are served under /.well-known/skills/.

The project is a monorepo: the create-docus CLI, the docus Nuxt layer that provides the theme, and the official documentation site. Projects are built on Nuxt 4, Nuxt UI 4, and Tailwind CSS 4, and can be deployed from a Vercel template.

Key features

  • 01Write pages in Markdown and embed Vue components with MDC syntax.
  • 02Scaffold a new docs project with a single npx command, with an optional i18n template.
  • 03Built-in client-side search with an optional FTS5 full-text search backend.
  • 04Dark mode, responsive layout, and theme customization via Nuxt UI 4 and Tailwind CSS 4.
  • 05Built-in MCP server and automatic llms.txt generation for AI tools.
  • 06Sitemap, robots.txt, and Open Graph image generation included.

Use cases

  • Publishing product or library documentation from a Git repository written in Markdown.
  • Building a multi-language documentation site with the i18n template.
  • Exposing project docs to AI assistants through the MCP server and llms.txt files.
  • Prototyping a documentation site on Nuxt and extending it with custom pages and components.

Topics

#documentation-generator#nuxt#markdown#vue#static-site#i18n#mcp#nuxt-theme

FAQ

What is docus?
A documentation site generator built on Nuxt that lets you write docs in Markdown with Vue components. Docus is a documentation framework built on Nuxt. A single CLI command scaffolds a docs project where pages are written in Markdown, optionally extended with Vue components through MDC syntax. The generated site includes a responsive theme with dark mode, client-side search, and an i18n template for multi-language docs.
Is docus free to use? What license does it have?
docus is open source under the MIT license. Check the license terms before using it in commercial products.
Is docus still maintained?
Actively maintained. The last commit to docus was on Oct 16, 2026.
What can I use docus for?
Publishing product or library documentation from a Git repository written in Markdown. Building a multi-language documentation site with the i18n template. Exposing project docs to AI assistants through the MCP server and llms.txt files. Prototyping a documentation site on Nuxt and extending it with custom pages and components.
Where can I get docus?
The source code and installation instructions are on GitHub: https://github.com/nuxt-content/docus

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects