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 代理的令牌浪費。