undocs
Minimal Documentation Theme and CLI for shared usage across UnJS projects. Use when creating documentation sites with Nuxt, Nuxt Content, and Nuxt UI.
npx skills add hairyf/skills --skill undocsBefore / After 效果对比
0 组description 文档
name: undocs description: Minimal Documentation Theme and CLI for shared usage across UnJS projects. Use when creating documentation sites with Nuxt, Nuxt Content, and Nuxt UI. metadata: author: hairy version: "2026.2.1" source: Generated from https://github.com/unjs/undocs, scripts located at https://github.com/hairyf/skills
Undocs 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 |
forum用户评价 (0)
发表评价
暂无评价,来写第一条吧
统计数据
用户评分
为此 Skill 评分