sourceysourcey · open-source documentation engine

Docs straight from the source.

sourcey turns OpenAPI, MCP, Doxygen, godoc, rustdoc, and Markdown into one static HTML site you own. Guides, changelog, roadmap, and llms.txt ship from the same build. Open source and free.

Get startedLive demo →
Explore live demosourcey demo. Cheese Store API documentation.
Install however you like
Get started

Empty directory to shipped docs in three commands.

init scaffolds the project, dev gives you hot reload, build emits static HTML.

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
  1. 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
  2. 02

    Write

    Writing Pages

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

    sourcey dev
  3. 03

    Ship

    Deploying

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

    sourcey build
Features

Six formats in. One site out.

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

Generate from what you have

OpenAPI, MCP, Doxygen XML, godoc, rustdoc, Markdown. Point sourcey at any of them 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 ten languages, from cURL to Rust.

  • 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.

Feels like the rest of your stack

TypeScript config, Vite dev server, 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.

Your output, your hosting

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. Deploy to GitHub Pages, Vercel, S3, anywhere.

  • Three theme presets

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

  • Dark mode

    Semantic design tokens, light/dark logo variants, localStorage persistence. Both modes designed in from day one.

  • 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.

Dark mode, search, themes, OG images, llms.txt. No plugin hunt, no add-on pricing.

Looks great either way.

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

My API
Search...
DocsAPI ReferenceChangelog
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/sdk@2.1.0
Quick Start
GETPOSTDELETE

Search that ships with the site.

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

⌘K
↑↓ navigate↵ open

Three layouts. Your brand.

Pick a preset that fits your docs, set your colors and fonts, and layer custom CSS on top.

docs.example.com
Getting StartedAPIGETPOSTDEL
On this page
EndpointsGETPOSTPUTDEL
GET
cURLJavaScriptPython
Response

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.Run it on the live demo.

Lighthouse Report
100
Performance
100
Accessibility
100
Best Practices
100
SEO
Comparison

How sourcey compares.

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

sourcey compared with hosted documentation platforms
FeaturesourceyRedoclyGitBookMintlifyFernReadMe
Open sourceYesPartialNoNoNoNo
Static outputYesYesNoNoNoNo
No client-side frameworkYesNoNoNoNoNo
Doxygen / C++ docsNativeNoNoNoNoNo
godoc / Go docsNativeNoNoNoNoNo
Config formatTypeScriptYAMLGUIJSONYAMLGUI
Local previewVite SSRLocalCloudLocalLocalCloud
No account requiredYesPartialNoNoNoNo
Self-hostedYesYesNoNoYesNo
PricingFree$10/user/mo$65/site/mo$250/mo$150/mo$250/mo

Compare with other tools

All comparisons →

Writing

All essays →

The machinery stays open.

The parsers, generators, and libraries are independent open-source projects. The catalog on this site's front door is a hosted layer above them; sourcey also runsthe open registry of startup programs.

  • sourcey

    The documentation engine: OpenAPI, MCP, Doxygen, godoc, rustdoc, and Markdown to one static site.

    GitHub ↗npm ↗

  • moxygen

    Generate Markdown documentation from Doxygen XML.

    GitHub ↗npm ↗

Own your docs.

Open source under AGPL-3.0. Fork it or run it on your own infrastructure.

View on GitHubRead the docs
Fork the demo →