sourcey/sourcey
Precision documentation from OpenAPI, MCP, Doxygen, and Markdown guides. Static HTML you own.
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 pipelines (like the Breathe/Exhale/Sphinx chain for C++) or relying on external hosting for language-specific docs (like pkg.go.dev).
How it works
It acts as a build-time generator that parses various inputs (OpenAPI, MCP, Doxygen XML, godoc, rustdoc, and Markdown) and renders them into static HTML. It uses a TypeScript-based configuration file (sourcey.config.ts) to define the site structure and navigation. The tool can be run as a CLI, integrated into Astro sites, or used via a Vite dev server for hot-reloading during development.
Who it’s for
It is designed for developers and technical writers who need to maintain comprehensive documentation for software projects, particularly those with multi-language codebases or complex API specifications, and who prefer owning their static output without runtime dependencies.
Highlights
- Multi-source support: Integrates OpenAPI (2.0 to 3.2), MCP server docs, Doxygen (C++), godoc (Go), and rustdoc (Rust).
- LLM-ready: Automatically generates
llms.txtandllms-full.txtfiles to provide portable context for AI models. - Rich Markdown: Supports custom components like steps, cards, and accordions within standard markdown files.
- Static Output: Produces framework-free HTML that can be deployed to any static host (GitHub Pages, Vercel, S3, etc.).
- Flexible Themes: Includes multiple layout options (default, minimal, api-first, and reader) with customizable colors and fonts.
Related
- Project
- Project
- Project
- Project
- Project