关于 undocs
这是一项关于 undocs 的技能；undocs 是基于 Nuxt 的文档主题和 CLI。内容涵盖站点创建与配置，以及组件、内容转换、博客、SEO 和面向 LLM 的内容功能。
主要功能
- 01undocs 项目初始化与 CLI 指南
- 02使用 docs.yaml 配置站点
- 03文档导航与首页定制
- 04Markdown 内容转换与组件
- 05博客、SEO 与 LLM 内容功能
适用场景
- 01使用 undocs 创建文档站点
- 02配置站点导航和首页
- 03在文档中加入 Mermaid 图表与提示框
- 04提供原始 Markdown 和 /llms.txt
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/undocs确认已加载。
包含的文件
除 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.md详细介绍
Undocs 是一个使用 Nuxt、Nuxt Content 和 Nuxt UI 构建的极简文档主题和命令行工具。它通过优雅的命令行封装、自动内容转换以及用于常见文档需求的内置组件，提供零配置文档站点。
该技能基于 undocs v0.4.15，生成于 2026-01-31。
核心参考
| 主题 | 描述 | 参考 |
|---|---|---|
| 快速开始 | 创建文档站点的快速开始指南 | core-getting-started |
| 命令行命令 | undocs 的开发和构建命令 | core-cli |
| 配置 | 使用 docs.yaml 配置文档站点 | core-configuration |
| 导航 | 导航系统和图标配置 | core-navigation |
| 项目结构 | 推荐的项目结构和组织方式 | core-project-structure |
| 落地页 | 落地页配置和 hero 自定义 | core-landing-page |
功能
组件
| 主题 | 描述 | 参考 |
|---|---|---|
| 提示框 | 注意、提示、重要、警告和小心提示框组件 | 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 |
| Prose 代码图标 | 代码块中的文件类型图标 | features-prose-code-icons |
内容转换
| 主题 | 描述 | 参考 |
|---|---|---|
| 内容转换 | 自动 markdown 转换（GitHub 提示框、代码组、步骤、配置引用） | features-content-transformation |
| 内容集合 | 包含/排除模式和源配置 | features-content-collections |
附加功能
| 主题 | 描述 | 参考 |
|---|---|---|
| 博客 | 创建和管理博客文章 | features-blog |
| SEO | SEO 优化和 Open Graph 图像生成 | features-seo |
| 原始 Markdown 与大模型 | 原始 markdown 输出、内容协商、/llms.txt | features-raw-markdown-llms |
| 贡献者与赞助者 | 在落地页显示贡献者和赞助者 | features-contributors-sponsors |
| Automd 集成 | 集成 automd 以自动更新文档 | features-automd |
最佳实践
| 主题 | 描述 | 参考 |
|---|---|---|
| 部署 | 将 undocs 站点部署到各种托管平台 | best-practices-deployment |
| 写作 | 组织和撰写内容的最佳实践 | best-practices-writing |
评论
支持 Markdown