Introduction — Sourcey

Sourcey builds a static docs site from the source of your product: specs, code, rich guides, changelog, roadmap pages, examples, and agent-readable context.

One config file, one build command. Developers get the browser site. Agents get llms.txt and llms-full.txt. The project keeps the source.

Most documentation tools are either hosted platforms that own your content, or bloated frameworks that ship megabytes of JavaScript to render a paragraph. Sourcey does neither. It reads your specs, code, and markdown, then writes HTML files to a directory. The output is yours. Put it on GitHub Pages, Cloudflare Pages, Netlify, S3, your own server. No account required, no vendor to migrate away from later.

What you get

API Reference

Point sourcey at an OpenAPI 3.2, 3.1, or 3.0 spec (or Swagger 2.0; it converts automatically). QUERY operations, hierarchical tags, response summaries, every schema and code sample rendered and searchable.

MCP Server Docs

Document MCP servers with tools, resources, and prompts rendered as browsable reference. Code samples in JSON-RPC, TypeScript, and Python.

Rich Guides

Write guides in markdown with frontmatter. Rich components (steps, tabs, cards, callouts) via directive syntax. No JSX imports.

Static Output

Zero JavaScript framework shipped to the browser. The output is plain HTML, one CSS file, and a small script for search and dark mode. Deploy it anywhere.

How it works

You create a sourcey.config.ts that declares your tabs, groups, and pages. Markdown files sit alongside it. An OpenAPI spec can be a local file or a URL.

sourcey build

Sourcey - building documentation site

  Pages:  14
  Output: dist
  Time:   1.2s

The dist/ directory contains your complete documentation site. Serve it with any static file server.

Get started in 60 seconds

npx sourcey init
npm install
npx sourcey dev

init is interactive; it prompts for a project name, picks a theme preset, and auto-detects any OpenAPI specs or Doxyfiles in your directory. It creates your config, example pages, and package.json. See the Quick Start for the full walkthrough.

Tip

Already have an OpenAPI spec? Skip the config entirely: sourcey build api.yaml generates a complete API reference from a single file.

See it in action

The Cheese Store demo is a full sourcey site with markdown guides, an OpenAPI-generated API reference, an MCP tools tab, five navigation tabs, custom branding, and every component type. The source is on GitHub; clone it, run sourcey dev, and you have a working reference project to build from.