Clarify

路线图

Clarify 采用分阶段迭代开发，每个阶段聚焦一组核心能力。

Phase 1 — 最小可用产品（当前）

✅ 已完成

目标

构建一个可用的文档发布工具，支持 MDX 渲染和静态站点生成。

已实现功能

  • MDX 编译与渲染
  • 基于文件系统的约定式路由
  • 构建时静态生成（SSG）
  • 客户端 Hydration
  • 内置渲染器样式管线
  • 配置文件系统（clarify.ts / clarify.js / clarify.json）
  • 基础主题配置（theme.preset 和 theme.tokens.colors.primary）
  • 顶部导航配置与自定义侧边栏导航
  • OpenAPI 集成 — 自动生成 API 文档页面或嵌入单个接口
  • 国际化（i18n）— 多语言目录、路由前缀和缺失语言策略
  • 内置搜索入口 — 基于路由和页面章节的客户端快速跳转
  • 亮色 / 暗色主题切换 — 支持系统偏好和手动切换
  • 插件钩子 — 支持路由、虚拟模块、HTML 变换和构建完成阶段扩展
  • AI-ready 内容产物和 llms.txt 输出，支持原始 Markdown/OpenAPI 内容引用

Phase 2 — 增强体验（开发中）

目标

在当前能力基础上增加高级功能，提升文档站点的可用性和可扩展性。

计划功能

  • 全文搜索索引 — 基于完整内容的客户端或静态索引搜索
  • 社交分享 — Open Graph 和 Twitter Card 支持
  • 编辑链接 — "在 GitHub 上编辑此页" 功能
  • 自定义 MDX 组件注册 — 将项目专属 React 组件稳定注册到 MDX 作用域

Phase 3 — 生态扩展（规划中）

目标

将 Clarify 扩展为更完整的文档生态系统。

设想功能

  • 搜索后端 — 基于 Algolia / Pagefind 的增强搜索
  • 版本管理 — 多版本文档并行展示
  • 评论系统 — 基于 Giscus / Utterances 的页面评论
  • 插件市场 — 第三方插件的发现和安装机制
  • CLI 工具 — 脚手架、内容校验、预览等命令行工具
  • VS Code 扩展 — 内容预览和自动补全

如何参与

如果你有功能建议或想参与开发，欢迎：