U

undocs

by @hairyfv
4.1(37)

使用极简文档主题和命令行工具,为AI项目创建、管理和共享文档,确保团队内部知识的有效传播和复用。

documentation-generationapi-documentationmarkdownstatic-site-generatorstechnical-writingGitHub
安装方式
npx skills add hairyf/skills --skill undocs
compare_arrows

Before / After 效果对比

1
使用前

多个项目文档格式不一,维护起来耗时费力,且用户阅读体验差。每次更新都需要手动调整样式和结构。

使用后

采用统一的文档主题和CLI工具,文档编写与维护变得高效便捷。确保了所有项目文档风格一致,提升了可读性。

SKILL.md

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

TopicDescriptionReference
Getting StartedQuick start guide for creating documentation sitescore-getting-started
CLI CommandsDevelopment and build commands for undocscore-cli
ConfigurationConfigure documentation site using docs.yamlcore-configuration
NavigationNavigation system and icon configurationcore-navigation
Project StructureRecommended project structure and organizationcore-project-structure
Landing PageLanding page configuration and hero customizationcore-landing-page

Features

Components

TopicDescriptionReference
AlertsNote, tip, important, warning, and caution alert componentsfeatures-alerts
Package ManagerCross-package-manager command components (npm, pnpm, yarn, bun, deno)features-package-manager
Read MoreStyled link component for cross-referencing pagesfeatures-read-more
Mermaid DiagramsRender Mermaid diagrams and flowcharts in documentationfeatures-mermaid
Nuxt UI ProseUse Nuxt UI Prose components in markdown filesfeatures-nuxt-ui-prose
Custom IconsAdd custom icon collections via .docs/iconsfeatures-custom-icons
Page Header LinksCopy markdown, open in ChatGPT/Claudefeatures-page-header-links
Prose Code IconsFile type icons in code blocksfeatures-prose-code-icons

Content Transformations

TopicDescriptionReference
Content TransformationsAutomatic markdown transformations (GitHub notes, code groups, steps, config references)features-content-transformation
Content CollectionsInclude/exclude patterns and source configurationfeatures-content-collections

Additional Features

TopicDescriptionReference
BlogCreate and manage blog postsfeatures-blog
SEOSEO optimization and Open Graph image generationfeatures-seo
Raw Markdown & LLMsRaw markdown output, content negotiation, /llms.txtfeatures-raw-markdown-llms
Contributors & SponsorsDisplay contributors and sponsors on landing pagefeatures-contributors-sponsors
Automd IntegrationIntegrate automd for automatic documentation updatesfeatures-automd

Best Practices

TopicDescriptionReference
DeploymentDeploy undocs sites to various hosting platformsbest-practices-deployment
WritingBest practices for structuring and writing contentbest-practices-writing

用户评价 (0)

发表评价

效果
易用性
文档
兼容性

暂无评价

统计数据

安装量384
评分4.1 / 5.0
版本
更新日期2026年5月22日
对比案例1 组

用户评分

4.1(37)
5
76%
4
24%
3
0%
2
0%
1
0%

为此 Skill 评分

0.0

兼容平台

🔧Claude Code
🔧OpenClaw
🔧OpenCode
🔧Codex
🔧Gemini CLI
🔧GitHub Copilot
🔧Amp
🔧Kimi CLI

时间线

创建2026年3月16日
最后更新2026年5月22日