UnDocs：8张图看懂文档建站

给自己的库搭文档站，除了写内容，还要处理导航、代码展示、搜索和发布。UnDocs 把这些常用能力整合起来，让你从 Markdown 和一份站点配置开始。
这次让葵用 8 张图，带你看懂它的使用方式，以及选之前需要考虑的成本 👇
🛠 上手路线
创建文档项目 → 配置站点信息 → 编写 Markdown → 本地预览 → 构建发布。
文件和目录负责组织页面，数字前缀控制导航顺序。例如 1.guide/2.usage.md，对应的地址是 /guide/usage。提示块、安装命令和代码高亮，也能直接用于文档内容。
✨ 它适合解决什么问题？
起步配置少，适合快速搭建库文档和工具指南。
内容放在 Markdown 中，方便跟代码一起用 Git 维护。
常用文档组件和搜索已集成，减少重复搭建工作。
⚠️ 这些成本也要知道
默认主题省事，深度定制仍需要理解框架和主题。
增强 Markdown 语法，迁移到其他工具时可能需要转换。
作者尚未承诺稳定性，升级前要验证已有页面和组件。
还有一个容易混淆的点：这套图的示例锁定 undocs@0.4.17，采用 Nuxt 方案；官网与主分支的新架构采用 Nitro + Vite。跟教程时，先确认自己的版本。 官方说明
我的选型建议：如果你想尽快把库文档整理成站点，愿意沿用默认主题，UnDocs 值得试用。复杂定制需求，先用几个真实页面验证，再决定是否采用。
#UnDocs #UnJS #开源工具 #文档站 #Markdown #前端开发 #开发者工具