Clarify

Clarify

开源文档发布工具，为 MDX、OpenAPI 和 AI 可读知识库而生。

Clarify 让文档留在代码仓库里：你维护 source/、OpenAPI 规范和 clarify.ts，它负责本地开发、路由生成、React 渲染、静态构建和 AI 友好的内容产物。

一眼看懂核心亮点

亮点用户价值
文档即代码MDX、OpenAPI、导航和主题配置都能进入 Git，天然适合 Review、版本化和协作。
MDX + OpenAPI 一体化产品指南、教程、组件示例和 API Reference 放在同一个文档站点里，接口面板可展示 server、认证、参数、示例和多语言请求代码。
内置导航与搜索文件路由、Tabs、分组侧边栏、H2/H3 章节和本地搜索一起工作，用户可以快速找到页面和具体章节。
纯静态发布每个路由生成独立 HTML，同时保留客户端导航体验，可部署到任意静态托管平台。
AI-ready 输出构建 .md、.openapi.* 和 llms.txt，页面上也提供复制原始内容、原始链接和 llms.txt 链接的操作。
可配置、可扩展TypeScript 配置覆盖导航、Tabs、国际化、主题 token、部署子路径、页脚和插件。

从哪里开始

你想做什么推荐阅读
第一次使用 Clarify快速开始
理解整体能力和适用场景能力概览
编写 MDX、组织目录和使用内置组件写作文档
配置导航、主题、国际化和路由配置站点
生成 API Reference 并嵌入接口API 文档
查看组件、主题和 OpenAPI 渲染效果示例与演示
静态构建、部署和输出 llms.txt发布上线
接入内容治理、搜索索引或额外产物插件机制

快速预览

推荐把 Clarify 作为项目开发依赖安装，这样 CLI 版本会跟随仓库一起被锁定和 Review：

pnpm init
pnpm add -D @clarify-labs/cli
pnpm exec clarify dev

clarify.ts

import { defineConfig } from '@clarify-labs/cli'

export default defineConfig({
  title: '我的文档',
  description: '这是 Clarify 驱动的文档站点',
  tabs: [{ tab: '文档', pages: 'FileTree' }],
})

然后在 source/ 目录下编写 .md / .mdx 文件，或放置 .openapi.json / .openapi.yaml 规范。Clarify 会自动生成路由、页面、静态 HTML、原始内容文件和 llms.txt。如果只是临时体验，也可以使用全局安装方式，详见 CLI 命令参考。

适合谁用

  • 开源项目维护者 — 需要文档和代码同仓库，方便社区贡献和版本追踪。
  • 技术写作者 / DevRel — 以 Markdown 为主，同时需要 React 组件、API Reference 和统一信息架构。
  • API 平台团队 — 希望把 OpenAPI 规范、任务型指南和 AI 可读接口源文件一起发布。
  • 内部知识库团队 — 需要可自托管、可接入内容治理和搜索索引的静态文档门户。

技术栈

  • React 19
  • Tailwind CSS 4（内部样式管线）
  • Vite 8（CLI 内部构建工具）
  • MDX 3
  • TypeScript 5（严格模式）