Skip to main content 首页 创作者 nuxt-content docus create-docs
create-docs 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.
跳到安装 Skills Marketplace 发现并探索由社区构建的 Agent Skills
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/nuxt-content/docus --skill create-docs命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
下载 Zip 下载中... Review documentation for quality, clarity, SEO, and technical correctness.
Optimized for Docus/Nuxt Content but works with any Markdown documentation.
Use when asked to: "review docs", "check documentation", "audit docs",
"validate documentation", "improve docs quality", "analyze documentation",
"check my docs", "review my documentation pages", "validate MDC syntax",
"check for SEO issues", "analyze doc structure".
Provides actionable recommendations categorized by priority (Critical, Important, Nice-to-have).
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
Analyze - Detect package manager, monorepo structure, read contextInitialize - Create docs directory with correct setupGenerate - Write documentation pages using templatesConfigure - Set up AI integration (MCP, llms.txt)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.yamlpnpm pnpm installpnpm runpnpm addpackage-lock.jsonnpm npm installnpm runnpm installyarn.lockyarn yarn installyarnyarn add
bun.lockb
Use [pm] as placeholder in commands below.
Step 1: Analyze Project
Detect Project Structure Check for:
├── pnpm-workspace.yaml → pnpm monorepo
├── turbo.json → Turborepo monorepo
├── lerna.json → Lerna monorepo
├── nx.json → Nx monorepo
├── apps/ → Apps directory (monorepo)
├── packages/ → Packages directory (monorepo)
├── docs/ → Existing docs (avoid overwriting)
├── README.md → Main documentation source
└── src/ or lib/ → Source code location
Determine Docs Location Project Type Target Directory Workspace Entry Standard project ./docsN/A Monorepo with apps/ ./apps/docsapps/docsMonorepo with packages/ ./docsdocsExisting docs/ folder Ask user or ./documentation —
Read Context Files File Extract README.mdProject name, description, features, usage examples package.jsonName, description, dependencies, repository URL src/ or lib/Exported functions, composables for API docs
Detect i18n Requirement Check if project needs multi-language docs:
Indicator Action @nuxtjs/i18n in dependenciesUse i18n template locales/ or i18n/ folder existsUse i18n template Multiple language README files Use i18n template User explicitly mentions multiple languages Use i18n template None of the above Use default template
Step 2: Initialize Docs
Create Directory Structure [docs-location]/
├── app/ # Optional: for customization
│ ├── app.config.ts
│ ├── components/
│ ├── layouts/
│ └── pages/
├── content/
│ ├── index.md
│ └── 1.getting-started/
│ ├── .navigation.yml
│ └── 1.introduction.md
├── public/
│ └── favicon.ico
├── package.json
└── .gitignore
i18n template (if multi-language detected):
[docs-location]/
├── app/
│ └── app.config.ts
├── content/
│ ├── en/
│ │ ├── index.md
│ │ └── 1.getting-started/
│ │ ├── .navigation.yml
│ │ └── 1.introduction.md
│ └── fr/ # Or other detected languages
│ ├── index.md
│ └── 1.getting-started/
│ ├── .navigation.yml
│ └── 1.introduction.md
├── nuxt.config.ts # Required for i18n config
├── public/
│ └── favicon.ico
├── package.json
└── .gitignore
Create package.json {
"name" : "[project-name]-docs" ,
"private" : true ,
"scripts" : {
"dev" : "nuxt dev --extends docus" ,
"build" : "nuxt build --extends docus" ,
"generate" : "nuxt generate --extends docus" ,
"preview" : "nuxt preview --extends docus"
} ,
"dependencies" : {
"docus" : "latest" ,
"better-sqlite3" : "^12.5.0" ,
"nuxt" : "^4.2.2"
}
}
{
"name" : "[project-name]-docs" ,
"private" : true ,
"scripts" : {
"dev" : "nuxt dev --extends docus" ,
"build" : "nuxt build --extends docus" ,
"generate" : "nuxt generate --extends docus" ,
"preview" : "nuxt preview --extends docus"
} ,
"dependencies" : {
"@nuxtjs/i18n" : "^10.2.1" ,
"docus" : "latest" ,
"better-sqlite3" : "^12.5.0" ,
"nuxt" : "^4.2.2"
}
}
Create nuxt.config.ts (i18n only) export default defineNuxtConfig ({
modules : ['@nuxtjs/i18n' ],
i18n : {
locales : [
{ code : 'en' , language : 'en-US' , name : 'English' },
{ code : 'fr' , language : 'fr-FR' , name : 'Français' }
],
defaultLocale : 'en'
}
})
Create .gitignore node_modules
.nuxt
.output
.data
dist
Update Monorepo Configuration (if applicable)
pnpm Monorepo
Add docs to workspace and configure onlyBuiltDependencies (required for better-sqlite3):
packages:
- 'apps/*'
- 'docs'
onlyBuiltDependencies:
- better-sqlite3
Add dev script to root package.json:
{
"scripts" : {
"docs:dev" : "pnpm run --filter [docs-package-name] dev"
}
}
{
"scripts" : {
"docs:dev" : "cd docs && pnpm dev"
}
}
npm/yarn Monorepo {
"workspaces" : [ "apps/*" , "docs" ] ,
"scripts" : {
"docs:dev" : "npm run dev --workspace=docs"
}
}
Step 3: Generate Documentation CRITICAL: MDC Component Naming
All Nuxt UI components in MDC must use the u- prefix:
Correct Wrong ::u-page-hero::page-hero::u-page-section::page-section:::u-page-feature:::page-feature:::u-button:::button::::u-page-card::::page-card
Without the u- prefix, Vue will fail to resolve the components.
Documentation Structure content/
├── index.md # Landing page
├── 1.getting-started/
│ ├── .navigation.yml
│ ├── 1.introduction.md
│ └── 2.installation.md
├── 2.guide/
│ ├── .navigation.yml
│ ├── 1.configuration.md
│ ├── 2.authentication.md
│ └── 3.deployment.md
└── 3.api/ # If applicable
├── .navigation.yml
└── 1.reference.md
Generate Pages
Landing page (index.md) - Hero + features gridIntroduction - What & why, use casesInstallation - Prerequisites, install commandsGuide pages - Feature documentation with action-based H2 headings
Step 4: Configure AI Integration Docus automatically includes MCP server (/mcp) and llms.txt generation. No configuration needed.
Do NOT add AI Integration sections to the landing page. These features work automatically.
Optionally mention in the introduction page:
::note
This documentation includes AI integration with MCP server and automatic `llms.txt` generation.
::
Optional: app.config.ts export default defineAppConfig ({
docus : {
name : '[Project Name]' ,
description : '[Project description]' ,
url : 'https://[docs-url]' ,
socials : {
github : '[org]/[repo]'
}
}
})
Optional: Theme Customization If the project has a design system or brand colors, customize the docs theme.
Custom CSS Create app/assets/css/main.css:
@import "tailwindcss" ;
@import "@nuxt/ui" ;
@theme {
--font-sans : 'Inter' , sans-serif;
--ui-container : 90rem ;
--color-primary-50 : oklch (0.97 0.02 250 );
--color-primary-500 : oklch (0.55 0.2 250 );
--color-primary-900 : oklch (0.25 0.1 250 );
}
Extended app.config.ts export default defineAppConfig ({
docus : {
name : '[Project Name]' ,
description : '[Project description]' ,
url : 'https://[docs-url]' ,
socials : {
github : '[org]/[repo]' ,
x : '@[handle]'
}
},
ui : {
colors : {
primary : 'emerald' ,
neutral : 'zinc' ,
},
pageHero : {
slots : {
title : 'font-semibold sm:text-6xl'
}
}
}
})
Step 5: Finalize Provide instructions using detected package manager.
Standard Project Documentation created in [docs-location]
To start:
cd [docs-location]
[pm] install
[pm] run dev
Available at http://localhost:3000
Monorepo Documentation created in [docs-location]
To start from root:
[pm] install
[pm] run docs:dev
Or from docs directory:
cd [docs-location]
[pm] run dev
Available at http://localhost:3000
Features Included
Full-text search
Dark mode
MCP server for AI tools (/mcp)
LLM integration (/llms.txt)
SEO optimized
Next Steps
Review generated content
Add more guides in content/2.guide/
Customize theme in app.config.ts
Deploy to Vercel/Netlify/Cloudflare
Suggest Follow-ups After documentation is created, suggest enhancements:
Your documentation is ready!
Would you like me to:
- **Customize the UI** - Match your brand colors and style
- **Enhance the landing page** - Add feature cards, code previews, visuals
- **Add i18n support** - Multi-language documentation
- **Set up deployment** - Deploy to Vercel, Netlify, or Cloudflare
Let me know what you'd like to improve!
Deployment Platform Command Output Vercel npx vercel --prodAuto-detected Netlify [pm] run generate.output/publicCloudflare Pages [pm] run generate.output/publicGitHub Pages [pm] run generate.output/public
Example: auth-utils Detected: pnpm monorepo, package in packages/
docs/
├── content/
│ ├── index.md
│ ├── 1.getting-started/
│ │ ├── .navigation.yml
│ │ ├── 1.introduction.md
│ │ └── 2.installation.md
│ ├── 2.guide/
│ │ ├── .navigation.yml
│ │ ├── 1.authentication.md
│ │ ├── 2.oauth-providers.md
│ │ └── 3.sessions.md
│ └── 3.api/
│ ├── .navigation.yml
│ └── 1.composables.md
├── public/
│ └── favicon.ico
├── package.json
└── .gitignore
Inside authentication.md (action-based H2 headings):
## Add basic authentication
## Protect your routes
## Handle login redirects
## Customize the session
