Docus skill
Two skills for Nuxt documentation: one builds a Docus site for a project, the other audits finished pages and writes a report.
- 3,126 ★ on the repository
- Last commit
- MIT
Extended access
Why this level
- The skill creates a docs folder in the repository, writes pages and installs dependencies through the package manager.
Install
- Works in
Manual install
npx skills add nuxt-content/docusThe README command installs the Docus skills for creating and reviewing documentation.
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- The skill creates a docs folder in the repository, writes pages and installs dependencies through the package manager.
This is third-party code. Review the repository files before installing.
What it does
Docus is a documentation theme built on Nuxt and Markdown, and the skills in its repository connect an agent to it. `create-docs` detects the package manager and project layout, monorepos included, creates the docs folder, writes pages from templates and sets up the MCP server and `llms.txt`. `review-docs` reads finished pages and checks frontmatter, MDC syntax, structure, SEO and translations. The result is a report that sorts findings into critical, important and nice-to-have. The agent starts fixing only after you agree. Every Docus site serves its own MCP server at `/mcp`, so the finished documentation can be connected to Cursor or VS Code.
Who it is for. Documentation authors for Nuxt and Vue projects and teams that want a Markdown documentation site without assembling it by hand.
Good fit when
- The repository has no documentation site and the agent must build one from the README and project layout.
- The project sits in a monorepo with `apps/` and `packages/` folders and the docs must land in the right place.
- Before a release you want pages scanned for broken frontmatter and MDC components without the `u-` prefix.
- The documentation ships in several languages and the translation structure needs a cross-check.
Not a fit when
- The documentation site already runs on another engine and a move to Nuxt is not planned.
- The repository must not be changed automatically: `create-docs` creates a docs folder and writes pages into it.
- The documentation lives in a wiki system or word processor rather than Markdown, while both skills read Markdown files.
Example request
Create a Docus documentation site for this project, then review the pages and show a report by priority.Limitations
The skills target Docus and Nuxt Content. `create-docs` builds a Docus project, while `review-docs` also reads plain Markdown, but its MDC syntax and `.navigation.yml` checks apply to Docus only. Running the site needs Node.js and a package manager, which `create-docs` picks from the lock file and defaults to npm without one. The docs folder is written straight into the repository, so commit your own changes first. The AI assistant on a Docus site runs through Vercel AI Gateway and needs separate setup.
How to disable. Delete the `create-docs` and `review-docs` folders from the agent skills directory. Remove the generated docs folder and the Docus dependencies from the project by hand.
FAQ
How do I install the Docus skills in Claude Code?
Run `npx skills add nuxt-content/docus`. Afterwards describe the task in words, for example "create documentation for this project", and the agent picks `create-docs`.
How does create-docs differ from review-docs?
`create-docs` builds a documentation site from scratch, while `review-docs` audits finished pages and writes a report. The first changes the repository right away, the second only reads files first.
How do I create a Docus project without the skill?
Run `npx create-docus my-docs`, then `cd my-docs` and `npm run dev`: the site opens at `http://localhost:3000`. For several languages add the `-t i18n` flag.
How do I connect the documentation MCP server to Cursor?
Every Docus site serves the server at `/mcp`. The Cursor and VS Code install buttons in the README link to that site's `/mcp/deeplink` pages.
Can I distribute my own skills through a Docus site?
Yes. The site serves files from the `skills/` folder at `/.well-known/skills/`, and users install them with `npx skills add https://your-docs-domain.com`.
Discussion
No questions or reviews yet.
Related
SkillsA CLI and skill for an agent to publish reports and specs as HTML documents that a team comments on, with every version kept
Four Claude Code plugins from Mintlify: reading others' docs, collaborative drafting, autonomous writing with PRs and style review of documentation
md-to-docx builds a ready Word document from Markdown: tables, footnotes, figure captions, headers and template patching.
A skill, an MCP server and a CLI turn Markdown from an agent into a short link to a web page that opens without signing in.
A document pipeline skill: anything to markdown, markdown to clean html and publisher-grade docx, and html back to markdown
The official Kingsoft Docs (WPS) skill set: Claude Code and Codex create and edit cloud documents through kdocs-cli
Comparison with similar tools
Cards that share the main search query, and how they differ.
| Tool | Official | Repository stars | Main difference |
|---|---|---|---|
| Docus (this card) | no | 3,126 | |
| Mintlify Workflows | yes | 466 | builds and reviews documentation on Mintlify; the Docus skills work with Nuxt Content and MDC markup |
| AI Documentation Generator | no | 771 | assembles a README and configs from repository code; here the output is a documentation site with search and MCP |
README in short
The repository holds the source of the `create-docus` CLI, the `docus` layer for Nuxt, the official documentation and starter templates. A finished site gets search, dark mode, multi-language support and `llms.txt` pages without extra setup.
README badge
Original SKILL.md
--- name: create-docs description: | Create complete documentation sites for projects. Use when asked to: "create docs", "add documentation", "setup docs site", "generate docs", "document my project", "write docs", "initialize documentation", "add a docs folder", "create a docs website". Generates Docus-based sites with search, dark mode, MCP server, and llms.txt integration. --- # Create Docs Generate a complete, production-ready documentation site for any project. ## Workflow 1. **Analyze** - Detect package manager, monorepo structure, read context 2. **Initialize** - Create docs directory with correct setup 3. **Generate** - Write documentation pages using templates 4. **Configure** - Set up AI integration (MCP, llms.txt) 5. **Finalize** - Provide next steps with correct commands --- ## Package Manager Reference Detect from lock files, default to npm if none found: | Lock File | PM | Install | Run | Add | |-----------|------|---------|-----|-----| | `pnpm-lock.yaml` | pnpm | `pnpm install` | `pnpm run` | `pnpm add` | | `package-lock.json` | npm | `npm install` | `npm run` | `npm install` | | `yarn.lock` | yarn | `yarn install` | `yarn` | `yarn add` | | `bun.lockb` | bun | `bun install` | `bun run` | `bun add` | Use `[pm]` as placeholder in commands below. --- ## Step 1: Analyze Project ### Detect Project Structure ``` Check for: