sourcey/sourcey

Precision documentation from OpenAPI, MCP, Doxygen, and Markdown guides. Static HTML you own.

解决的问题

Sourcey 通过将 API 规范、源代码注释和 Markdown 指南等多种文档格式整合为一个统一的静态 HTML 网站，解决了技术文档分散的问题。它消除了对复杂工具链（如 C++ 的 Breathe/Exhale/Sphinx 流水线）或依赖外部托管服务来提供 API 参考文档的需求。

工作原理

它作为一个静态网站生成器，在构建时解析多种文档源，并将其渲染为可移植的 HTML 站点。通过配置文件（sourcey.config.ts）支持多种输入类型，包括：

  • API 规范：OpenAPI（2.0 至 3.2）和 MCP 服务器文档。
  • 源代码：Doxygen XML（C++）、原生 Go 工具链提取（godoc），以及夜间版 rustdoc JSON（Rust）。
  • 指南：Markdown 文件和现有的 MkDocs 结构。

该工具提供基于 Vite 的开发服务器以支持热重载，并可直接集成到 Astro 站点中，或作为独立静态文件部署到任何主机。

适用人群

专为需要维护复杂 API 或多语言代码库的软件项目的专业、可搜索文档的开发者和技术写作者设计。

主要亮点

  • 统一构建：通过一次构建流程生成 API 参考、指南、变更日志和路线图。
  • LLM 就绪：自动生成 llms.txt 和 llms-full.txt 文件，为 AI 模型提供可移植的上下文。
  • 广泛语言支持：原生支持 Go 和 Rust 文档，C++ 通过 Doxygen 支持。
  • 丰富 Markdown：内置步骤、卡片和折叠面板组件，增强指南体验。
  • 零运行时：仅生成静态 HTML，无需仪表板或渲染时的 API 调用。

相关

  • 项目
    docmd-io/docmd

    一个将 Markdown 文件转换为快速、生产就绪的静态网站的 AI 原生文档生成器，无需任何配置。

  • 项目
    FSoft-AI4Code/CodeWiki

    CodeWiki is an open‑source Python framework that uses LLMs (OpenAI, Anthropic, Azure, Bedrock, Atlas Cloud, or Claude/Codex subscription) to automatically generate comprehensive, architecture‑aware documentation—including markdown and Mermaid diagrams—for large, multi‑language codebases. It features hierarchical decomposition, recursive multi‑agent processing, configurable token limits, incremental updates, and GitHub‑Pages‑ready output.

  • 项目
    tomehq/tome

    一个开源文档平台，可将 Markdown 和 MDX 转换为专业文档网站，内置 AI 聊天和 OpenAPI API 参考。

  • 项目
    codeforequity-at/botium-speech-processing

    一个用于开源与云端语音转文字 (STT) 和文字转语音 (TTS) 服务的统一 API，简化了聊天机器人和语音应用的音频处理流程。

  • 项目
    knowsuchagency/mcp2cli

    一个运行时 CLI 生成器，可将 MCP 服务器、OpenAPI 规范和 GraphQL 端点转换为命令行工具，以减少 AI 代理的令牌浪费。