能力概览

Clarify 的定位很清晰：把“写文档、生成 API Reference、发布静态站点、让 AI 读取文档”放进同一个本地优先工作流。

---

核心亮点

亮点	Clarify 已经提供什么	继续阅读
快速建站	clarify dev、clarify build、默认文档外壳、文件路由和静态输出	快速开始
MDX 内容写作	Frontmatter、React 组件、代码高亮、内置 Callout/Card/Code/Layout/OpenAPI 组件、目录结构路由	写作文档
OpenAPI 一等支持	.openapi.json/.yaml/.yml 解析、完整 API Reference、单接口嵌入、tag 分组、server/认证/示例/请求代码面板、构建时校验	API 文档
内置搜索体验	根据页面标题、导航分组、路径和 H2/H3 章节提供本地搜索，帮助用户快速跳到目标章节	写作文档
AI-ready 发布	原始 Markdown/OpenAPI 输出、页面复制操作、原始内容链接、llms.txt 发现入口	发布上线
多语言与导航	locale 目录、缺失翻译策略、Tabs、分组侧边栏、redirect、OpenAPI tag filter、外链、图标和本地化文案	配置站点
主题与品牌	React 19 + Tailwind CSS 4 渲染器、主题预设、颜色 token、圆角 token、布局宽度、亮暗主题启动脚本	配置参考
可视化效果验证	内置组件、OpenAPI Reference、单接口嵌入和主题配置的真实渲染示例	示例与演示
可扩展构建管线	routes:resolved、modules:before、build:done Hook，可生成搜索索引、治理报告或内部平台产物	插件机制
部署控制权	纯静态产物、routePrefix 子路径、Vercel/Netlify/GitHub Pages/Nginx 等平台部署	发布上线

---

用户路径

1. 启动站点：安装 CLI，创建 clarify.ts 和 source/。
2. 写内容：用 MDX 组织首页、指南、参考页和组件示例，并用清晰的 H2/H3 提升目录和搜索体验。
3. 接入 API：放入 OpenAPI 规范，生成 Reference，在指南里嵌入关键接口，并为开发者提供可复制请求代码。
4. 配置信息架构：用 Tabs、分组、导航、redirect、页脚和多语言配置组织阅读路径。
5. 发布和供 AI 读取：构建静态站点，同时输出原始内容文件和 llms.txt。
6. 扩展团队流程：需要内容治理、翻译检查、全文搜索索引或自定义产物时接入插件。

---

设计理念

1. 从用户任务出发：文档按“开始、写作、配置、API、发布、扩展”组织，而不是每个内部能力单独开一篇。
2. 内容靠近代码：MDX、OpenAPI 和配置都放在仓库里，方便版本管理和 Review。
3. 静态优先：构建产物可以部署到任何静态托管平台，也能被搜索引擎和 AI 工具读取。
4. 渐进扩展：默认能力开箱即用；需要搜索、治理或额外输出时再接入插件。