sourcey/sourcey

What it solves

Sourcey solves the problem of fragmented technical documentation by consolidating multiple source formats—such as API specifications, source code comments, and markdown guides—into a single, unified, static HTML website. It eliminates the need for complex toolchains (like the Breathe/Exhale/Sphinx pipeline for C++) or relying on external hosting services for API references.

How it works

It acts as a static site generator that parses various documentation sources at build time and renders them into a portable HTML site. It supports multiple input types via a configuration file (sourcey.config.ts), including:

• API Specs: OpenAPI (2.0 through 3.2) and MCP server documentation.
• Source Code: Doxygen XML (C++), native Go toolchain extraction (godoc), and nightly rustdoc JSON (Rust).
• Guides: Markdown files and existing MkDocs structures.

The tool provides a Vite-powered development server for hot reloading and can be integrated directly into Astro sites or deployed as standalone static files to any host.

Who it’s for

It is designed for developers and technical writers who need to maintain professional, searchable documentation for software projects, particularly those with complex APIs or multi-language codebases.

Highlights

• Unified Build: Generates API references, guides, changelogs, and roadmaps from one build process.
• LLM-Ready: Automatically generates llms.txt and llms-full.txt files to provide portable context for AI models.
• Broad Language Support: Native support for Go and Rust documentation, and C++ via Doxygen.
• Rich Markdown: Includes built-in components like steps, cards, and accordions for enhanced guides.
• Zero Runtime: Produces static HTML with no dashboard or API calls required for rendering.