sourcey/sourcey

解决的问题

Sourcey 通过将 API 规范、源代码注释和 Markdown 指南等多种来源格式整合为一个统一的静态 HTML 网站，解决了技术文档分散的问题。它无需复杂的构建流水线（如 C++ 的 Breathe/Exhale/Sphinx 链），也无需依赖外部托管服务来提供语言特定的文档（如 pkg.go.dev）。

工作原理

它作为构建时生成器，解析多种输入（OpenAPI、MCP、Doxygen XML、godoc、rustdoc 和 Markdown），并将其渲染为静态 HTML。使用基于 TypeScript 的配置文件（sourcey.config.ts）定义网站结构和导航。该工具可作为 CLI 运行，集成到 Astro 站点中，或通过 Vite 开发服务器使用以在开发过程中实现热重载。

适用人群

专为需要维护多语言代码库或复杂 API 规范的软件项目全面文档的开发者和技术写作者设计，尤其适合希望自主掌控静态输出、不依赖运行时依赖的用户。

主要亮点

• 多源支持：集成 OpenAPI（2.0 至 3.2）、MCP 服务器文档、Doxygen（C++）、godoc（Go）和 rustdoc（Rust）。
• LLM 就绪：自动生成 llms.txt 和 llms-full.txt 文件，为 AI 模型提供可移植的上下文。
• 丰富 Markdown：在标准 Markdown 文件中支持自定义组件，如步骤、卡片和折叠面板。
• 静态输出：生成无框架的 HTML，可部署到任何静态主机（GitHub Pages、Vercel、S3 等）。
• 灵活主题：提供多种布局选项（默认、极简、API 优先、阅读者），并支持自定义颜色和字体。