Sourcey Sourcey · open-source documentation engine

The whole product story.

Docs straight from the source. Specs, code, rich guides, changelog, roadmap, examples, and portable context files from your project, rendered as static HTML you own. Yours and completely free.

Live demo →

Specs + code

OpenAPI, MCP, Doxygen, godoc, rustdoc, and rich guides in one site.

Product story

Changelog, roadmap pages, examples, and reference together.

Static output

Builds to static HTML. Deploy anywhere.

Agent-readable

llms.txt and llms-full.txt generated from the same source.

Get started

No global install. Each command fetches sourcey on the fly.

$ npx sourcey init
✓ Created sourcey.config.ts
$ npx sourcey dev
✓ http://localhost:4400
$ npx sourcey build
✓ Static HTML → dist/
All install paths → Docs →
Explore live demo
Sourcey demo. Cheese Store API documentation.
Install however you like
Get started

Ship it before the coffee's cold.

Three commands from empty directory to a shipped docs site.

Terminal
$ npx sourcey init
› Created sourcey.config.ts
› Added 3 example pages
✓ Ready
$ sourcey dev
› Parsing openapi.yaml (42 endpoints)
› Rendering 12 pages
✓ Sourcey v3.6
http://localhost:4400
Ready in 1.2s
$ sourcey build
› Writing 50 pages to dist/
✓ Built in 1.8s
01

Configure

Configuration Reference

Point it at your OpenAPI spec, MCP server, or markdown. One TypeScript file, type-checked with full autocomplete.

npx sourcey init
02

Write

Writing Pages

Markdown with rich components: steps, cards, accordions, code blocks. Guides alongside your API reference.

sourcey dev
03

Ship

Deploying

Static HTML with no runtime. Deploy to GitHub Pages, Vercel, S3, or anywhere you serve files.

sourcey build
Features

Every source format. One site.

Search, themes, and context exports, all from one build.

Generate from anything

One site from every spec format you use. Point sourcey at what you have and it renders the reference.

  • OpenAPI 2.0 through 3.2

    Full spec coverage including 3.2's `QUERY` operations, hierarchical tags, and response summaries. Endpoints, schemas, and auto-generated code samples in cURL, JavaScript, Python, Go, Ruby, Rust, and more.

  • MCP server docs

    Tools, resources, and prompts rendered as browsable reference. JSON-RPC, TypeScript, and Python code samples.

  • C++ and Java via Doxygen

    Feed in Doxygen XML output and get modern, searchable API docs. Works with Moxygen for Markdown-based rendering.

  • Go and Rust, natively

    Go package docs from the Go toolchain, no Doxygen detour, and Rust crate docs from rustdoc JSON via the sourcey-rustdoc binary.

  • Markdown and MkDocs

    Rich Markdown components (steps, cards, accordions, tabbed code), plus existing mkdocs.yml sites brought across whole: nav, snippets, admonitions, assets.

Built for developers

The toolchain feels like the rest of your stack. TypeScript, Vite, instant feedback.

  • TypeScript config

    sourcey.config.ts with defineConfig(). Full autocomplete, type checking. One file defines your entire docs site.

  • Vite dev server

    SSR hot reload on every component and CSS change. Spec and markdown changes trigger instant refresh.

  • Instant search

    Client-side fuzzy search across all pages and API operations. Cmd+K to find anything. Works offline.

  • Install anywhere

    npx sourcey with no global install, or install once via Homebrew, Docker, or Nix.

  • Builds in CI

    One build command drops into GitHub Actions or any pipeline. The docs rebuild from source on every push.

Ship with confidence

Control how it looks and where it goes. Three theme presets, design tokens, static HTML output, your deploy target.

  • Static HTML output

    Zero framework runtime shipped. No vendor lock-in. Deploy to GitHub Pages, Vercel, S3, anywhere.

  • Three theme presets

    Default sidebar + TOC. Minimal single column. API-first three-column like Stripe. Colors, fonts, and custom CSS on top.

  • Dark mode

    Semantic design tokens, light/dark logo variants, localStorage persistence. Designed for both modes, not retrofitted.

  • OG image cards

    Social preview images generated at build time, one per page, from the same source.

  • Context exports

    Auto-generate llms.txt and llms-full.txt alongside your HTML as alternate views of the same documentation graph.

Built in

Built in, not bolted on.

Every feature ships with every build. Nothing to install, nothing to configure.

Looks great either way.

Semantic design tokens, light and dark logo variants, localStorage persistence. Every component designed for both modes.

My API
Search...
Docs API Reference Changelog
Getting Started
Introduction
Quick Start
Authentication
Concepts
Webhooks
Directives
Introduction
Welcome to the API documentation. This guide covers authentication, endpoints, and best practices.
$ npm install @myapi/sdk
+ @myapi/[email protected]
Quick Start
GET
POST
DELETE
⌘K
↑↓ navigate ↵ open

Find anything. Instantly.

Client-side fuzzy search across every page and API operation. Cmd+K, start typing. Works offline, no server required.

Three layouts. Your brand.

Pick a preset that fits your docs. Set your colors and fonts. Add custom CSS on top. Ship it.

docs.example.com
Getting Started
API
GET
POST
DEL
Endpoints
GET
POST
PUT
DEL
GET
cURL
JavaScript
Python
Response
Lighthouse Report
100
Performance
100
Accessibility
100
Best Practices
100
SEO

100/100 across the board.

No framework runtime to download, parse, or execute. Every page is semantic HTML with one stylesheet, and the only JavaScript is small vanilla code for search and navigation. Performance, accessibility, best practices, and SEO all score green.

Comparison

The state of documentation.

Your source code shouldn't need a SaaS platform to speak for itself.

Sourcey Redocly GitBook Mintlify Fern ReadMe
Open source Yes Partial No No No No
Static output Yes Yes No No No No
No client-side framework Yes No No No No No
Doxygen / C++ docs Native No No No No No
godoc / Go docs Native No No No No No
Config format TypeScript YAML GUI JSON YAML GUI
Local preview Vite SSR Local Cloud Local Local Cloud
No account required Yes Partial No No No No
Self-hosted Yes Yes No No Yes No
Pricing Free $10/user/mo $65/site/mo $250/mo $150/mo $250/mo
Sourcey

Own your docs.

Open source under AGPL. Self-host it, fork it, run it on your own infrastructure.

View on GitHub npx sourcey init
Fork the demo →