Summary

Sourcey provides an open-source platform for generating static HTML documentation sites from OpenAPI specs, MCP servers, Doxygen output, and Markdown guides. It targets developers and teams seeking to avoid SaaS vendor lock-in and maintain full ownership of their documentation infrastructure, offering a self-hostable solution deployable anywhere.

How It Works

The platform ingests diverse sources like OpenAPI, MCP, and Doxygen XML, alongside Markdown. It utilizes a Vite dev server with SSR and hot-reloading for an efficient development workflow. A key advantage is generating static HTML with zero client-side JavaScript, ensuring optimal performance and minimal footprint. Configuration is managed via sourcey.config.ts, enabling granular control over theming, navigation, and layout.

Quick Start & Requirements

Installation is available via npm (npx sourcey init), Homebrew, Docker, or Nix. Core commands include sourcey dev for local development and sourcey build for static site generation. Configuration is handled in sourcey.config.ts. Standard Node.js/npm environments are sufficient for the primary installation method. Official resources include a live demo, documentation, and the GitHub repository.

Highlighted Details

• Native support for MCP server and Doxygen C++ API documentation.
• Generates static HTML with zero client-side JavaScript.
• Auto-generates llms.txt and llms-full.txt for AI agents.
• Offers multiple theme presets (default, minimal, api-first) and extensive customization.
• Includes client-side fuzzy search.

Maintenance & Community

The provided README does not detail specific community channels, maintainers, sponsorships, or a public roadmap. Assessment of project health requires further investigation of the GitHub repository.

Licensing & Compatibility

Sourcey is licensed under AGPL-3.0. This strong copyleft license requires derivative works or hosted services to be open-sourced. Commercial licensing is available upon contact with sourcey.com.

Limitations & Caveats

The AGPL-3.0 license's copyleft requirements may restrict proprietary integration or distribution without open-sourcing. The README does not specify performance benchmarks, known bugs, or platform-specific limitations beyond licensing.