undocs
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseUndocs 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.
Undocs是一款基于Nuxt、Nuxt Content和Nuxt UI构建的轻量级文档主题与CLI工具。它提供零配置的文档站点，包含简洁的CLI封装、自动内容转换功能，以及满足常见文档需求的内置组件。
本技能基于undocs v0.4.15版本生成，生成时间为2026年1月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 |
| 主题 | 描述 | 参考链接 |
|---|---|---|
| 快速入门 | 创建文档站点的快速入门指南 | core-getting-started |
| CLI命令 | Undocs的开发与构建命令 | core-cli |
| 配置 | 使用docs.yaml配置文档站点 | core-configuration |
| 导航系统 | 导航系统与图标配置 | core-navigation |
| 项目结构 | 推荐的项目结构与组织方式 | core-project-structure |
| 首页配置 | 首页配置与Hero区域自定义 | 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 |
| 主题 | 描述 | 参考链接 |
|---|---|---|
| 提示组件 | 包含注意、提示、重要、警告、警示类型的提示组件 | features-alerts |
| 包管理器组件 | 跨包管理器命令组件（支持npm、pnpm、yarn、bun、deno） | features-package-manager |
| 阅读更多组件 | 用于跨页面引用的样式化链接组件 | features-read-more |
| Mermaid图表 | 在文档中渲染Mermaid图表与流程图 | features-mermaid |
| Nuxt UI Prose组件 | 在Markdown文件中使用Nuxt UI Prose组件 | features-nuxt-ui-prose |
| 自定义图标 | 通过.docs/icons添加自定义图标集合 | features-custom-icons |
| 页面头部链接 | 复制Markdown内容、在ChatGPT/Claude中打开 | features-page-header-links |
| 代码块文件图标 | 代码块中的文件类型图标 | 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 |
| 主题 | 描述 | 参考链接 |
|---|---|---|
| 内容转换 | 自动Markdown转换（GitHub注释、代码组、步骤、配置参考） | features-content-transformation |
| 内容集合 | 包含/排除规则与源配置 | 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 |
| 主题 | 描述 | 参考链接 |
|---|---|---|
| 博客功能 | 创建与管理博客文章 | features-blog |
| SEO优化 | SEO优化与Open Graph图片生成 | features-seo |
| 原始Markdown与LLM | 原始Markdown输出、内容协商、/llms.txt | features-raw-markdown-llms |
| 贡献者与赞助商 | 在首页展示贡献者与赞助商 | features-contributors-sponsors |
| Automd集成 | 集成automd实现文档自动更新 | 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 |
| 主题 | 描述 | 参考链接 |
|---|---|---|
| 部署指南 | 将Undocs站点部署到各类托管平台 | best-practices-deployment |
| 写作规范 | 内容结构与写作的最佳实践 | best-practices-writing |