About undocs
A skill for using undocs, a Nuxt-based documentation theme and CLI. It covers site setup and configuration, plus components, content transformations, and features for blogs, SEO, and LLM-readable content.
Key features
- 01undocs 项目初始化与 CLI 指南
- 02使用 docs.yaml 配置站点
- 03文档导航与首页定制
- 04Markdown 内容转换与组件
- 05博客、SEO 与 LLM 内容功能
Use cases
- 01使用 undocs 创建文档站点
- 02配置站点导航和首页
- 03在文档中加入 Mermaid 图表与提示框
- 04提供原始 Markdown 和 /llms.txt
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/undocsin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
GENERATION.mdreferences/best-practices-deployment.mdbest-practices-writing.mdcore-cli.mdcore-configuration.mdcore-getting-started.mdcore-landing-page.mdcore-navigation.mdcore-project-structure.mdfeatures-alerts.mdfeatures-automd.mdfeatures-blog.mdfeatures-content-collections.mdfeatures-content-transformation.mdfeatures-contributors-sponsors.mdfeatures-custom-icons.mdfeatures-mermaid.mdfeatures-nuxt-ui-prose.mdfeatures-package-manager.mdfeatures-page-header-links.mdfeatures-prose-code-icons.mdfeatures-raw-markdown-llms.mdfeatures-read-more.mdfeatures-seo.mdDetails
From the project READMEUndocs is a minimal Documentation Theme and CLI built with Nuxt, Nuxt Content, and Nuxt UI. It provides zero-config documentation sites with elegant CLI wrapper, automatic content transformations, and built-in components for common documentation needs.
The skill is based on undocs v0.4.15, generated at 2026-01-31.
Core References
| Topic | Description | Reference |
|---|---|---|
| Getting Started | Quick start guide for creating documentation sites | core-getting-started |
| CLI Commands | Development and build commands for undocs | core-cli |
| Configuration | Configure documentation site using docs.yaml | core-configuration |
| Navigation | Navigation system and icon configuration | core-navigation |
| Project Structure | Recommended project structure and organization | core-project-structure |
| Landing Page | Landing page configuration and hero customization | core-landing-page |
Features
Components
| Topic | Description | Reference |
|---|---|---|
| Alerts | Note, tip, important, warning, and caution alert components | features-alerts |
| Package Manager | Cross-package-manager command components (npm, pnpm, yarn, bun, deno) | features-package-manager |
| Read More | Styled link component for cross-referencing pages | features-read-more |
| Mermaid Diagrams | Render Mermaid diagrams and flowcharts in documentation | features-mermaid |
| Nuxt UI Prose | Use Nuxt UI Prose components in markdown files | features-nuxt-ui-prose |
| Custom Icons | Add custom icon collections via .docs/icons | features-custom-icons |
| Page Header Links | Copy markdown, open in ChatGPT/Claude | features-page-header-links |
| Prose Code Icons | File type icons in code blocks | features-prose-code-icons |
Content Transformations
| Topic | Description | Reference |
|---|---|---|
| Content Transformations | Automatic markdown transformations (GitHub notes, code groups, steps, config references) | features-content-transformation |
| Content Collections | Include/exclude patterns and source configuration | features-content-collections |
Additional Features
| Topic | Description | Reference |
|---|---|---|
| Blog | Create and manage blog posts | features-blog |
| SEO | SEO optimization and Open Graph image generation | features-seo |
| Raw Markdown & LLMs | Raw markdown output, content negotiation, /llms.txt | features-raw-markdown-llms |
| Contributors & Sponsors | Display contributors and sponsors on landing page | features-contributors-sponsors |
| Automd Integration | Integrate automd for automatic documentation updates | features-automd |
Best Practices
| Topic | Description | Reference |
|---|---|---|
| Deployment | Deploy undocs sites to various hosting platforms | best-practices-deployment |
| Writing | Best practices for structuring and writing content | best-practices-writing |
Comments
Markdown supported