Docs from the source.

Sourcey turns OpenAPI, MCP, Doxygen, godoc, rustdoc and Markdown into docs you’re proud to put your name on. Built for people and agents, with the source, design and hosting under your control.

Get started Live demo

Cheesestore API operation with typed request fields and generated code examples

Take it home with you

Setup commands

npx sourcey init
npm install
npm run dev
# Stop the preview with Ctrl+C, then build:
npm run build

Project dependencies use npm. Requires Node.js 22.19 or later.

All installation options

Get started

Empty directory to shipped docs.

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

Terminal

$ npx sourcey init

Created sourcey.config.ts

Created introduction.md

Created quickstart.md

Created package.json

Created .gitignore

✓ Created sourcey project in ./

$ npm install

$ npm run dev

Sourcey dev server running at

http://localhost:4400/

Press Ctrl+C to stop

$ npm run build

Sourcey: building documentation site

✓ Output: ./dist

Configure

Configuration Reference

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

npx sourcey init

sourcey.config.ts

import { defineConfig, markdown, openapi, mcp } from "sourcey";

export default defineConfig({
  name: "Cheese Store",
  navigation: {
    tabs: [
      {
        tab: "Guides", slug: "",
        source: markdown({
          groups: [{ group: "Start", pages: ["introduction"] }],
        }),
      },
      { tab: "API", slug: "api", source: openapi("./cheese.yml") },
      { tab: "MCP", slug: "mcp", source: mcp("./cheesestore.mcp.json") },
    ],
  },
});

02
Write
Writing Pages
Markdown with rich components: steps, cards, accordions, code blocks. Guides alongside your API reference.
npm run dev
03
Ship
Deploying
Static HTML with no runtime. Deploy to GitHub Pages, Vercel, S3, or anywhere you serve files.
npm run build

Make it yours

Technical docs can look this good.

Theme configuration

Four themes give you a starting point. Set your own fonts and colours, then use CSS for the details.

MailSchema's specification in Sourcey's Reader theme, with its dark masthead and chapter navigation

Reader · MailSchema’s specification, with chapter navigation and editorial typography.

Read the specification

Built with Sourcey

Reference from your specs and code.

Parameters, nested types, responses and request examples come from your API definition. Doxygen, godoc and rustdoc bring your library reference into the same site.

POST /cheeses5 languages

Source file Full API reference

CheeseInputOpenAPI

Source file Full API reference

WebSocketFramer::readFrameDoxygen

Source file Full C++ reference

URL.JoinPathgodoc · net/url

Source file Full Go reference

Url::set_queryrustdoc · url 2.5.8

Source file Full Rust reference

Search down to the endpoint.

Find a guide, an API operation or a parameter. Results take you straight to the page or endpoint. The search index ships with your site and works offline.

↑↓ navigate↵ open

Give your agent the reference.

Give it the operation it needs, with parameters, authentication and examples intact. Schemas, guides and library reference have their own readable documents too. Publish the OpenAPI contract, ARD, API catalog and llms.txt alongside them.

Export and discovery configuration

api/operations/operation-cheeses-cheeseid-get.md

# GET /cheeses/{cheeseId}

Get cheese by ID

Returns detailed information about a specific cheese, including its category, tags, and current availability status.


Parameters:

- `cheeseId` (path, integer, int64, required) - Unique identifier for the cheese
  Type: integer, int64
  
  minimum: 1

Responses:

- 200: Cheese details

Content type: application/json

Type: object

Schema: [Cheese](https://sourcey.com/examples/docs-showcase/api/schemas/cheese-6e5a59d4fd.md)

- `id` (required)
  Type: integer, int64

Readable Markdown · CheesestoreDownload file

api/schemas/cheese-6e5a59d4fd.md

# Cheese

Type: object

Schema: [Cheese](https://sourcey.com/examples/docs-showcase/api/schemas/cheese-6e5a59d4fd.md)

- `id` (required)
  Type: integer, int64
  
  Unique identifier
  
  Example:
  
  ```json
  42
  ```

- `name` (required)
  Type: string
  
  Name of the cheese
  
  minLength: 1
  
  maxLength: 100

Readable Markdown · CheesestoreDownload file

api/openapi.json

{
  "openapi": "3.1.0",
  "info": {
    "title": "Cheese Store",
    "version": "2.0.0"
  },
  "paths": {
    "/cheeses/{cheeseId}": {
      "get": {
        "tags": [
          "Cheese"
        ],
        "summary": "Get cheese by ID",
        "description": "Returns detailed information about a specific cheese, including its category, tags, and current availability status.",
        "operationId": "getCheeseById",
        "responses": {
          "200": {
            "description": "Cheese details",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Cheese"
                },
                "example": {
                  "id": 42,
                  "name": "Gorgonzola",
                  "category": {
                    "id": 1,
                    "name": "Italian Cheese"
                  },
                  "status": "available",
                  "photoUrls": [
                    "https://wannabechef.com/gorgonzola.jpg"
                  ],
                  "tags": [
                    {
                      "id": 1,
                      "name": "blue"
                    },
                    {
                      "id": 2,
                      "name": "italian"
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    }
  }
}

Excerpt from CheesestoreDownload file

ard.json

{
  "entries": [
    {
      "identifier": "urn:air:sourcey.com:docs:22f23f8fe5db:documents",
      "displayName": "Cheese Store documentation",
      "type": "application/json",
      "url": "https://sourcey.com/examples/docs-showcase/documents.json",
      "description": "Index of guides, API operations, schemas and library reference with readable Markdown URLs."
    },
    {
      "identifier": "urn:air:sourcey.com:docs:22f23f8fe5db:llms",
      "displayName": "Documentation index",
      "type": "text/plain",
      "url": "https://sourcey.com/examples/docs-showcase/llms.txt",
      "description": "Links to individual reference documents and guides."
    }
  ]
}

Excerpt from CheesestoreDownload file

api-catalog.json

{
  "linkset": [
    {
      "anchor": "https://cheese.example.com/v2",
      "service-desc": [
        {
          "href": "https://sourcey.com/examples/docs-showcase/api/openapi.json",
          "type": "application/json"
        }
      ],
      "service-doc": [
        {
          "href": "https://sourcey.com/examples/docs-showcase/api.html",
          "type": "text/html"
        }
      ]
    }
  ]
}

Excerpt from CheesestoreDownload file

llms.txt

# Cheese Store

## Guides

- [Webhooks](https://sourcey.com/examples/docs-showcase/webhooks.md): Receive and verify events from the Cheese Store.

## API Reference

- [Cheese Store](https://sourcey.com/examples/docs-showcase/api.md): This is a fictional API contract used to demonstrate documentation generated by Sourcey. The Cheese Store service, accounts, keys, and endpoints are examples; there is no live cheese-ordering service behind this reference.
- [GET /cheeses](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-get.md): List all cheeses
- [POST /cheeses](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-post.md): Add a new cheese
- [PUT /cheeses](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-put.md): Update an existing cheese
- [GET /cheeses/findByStatus](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-findbystatus-get.md): Find cheeses by status
- [GET /cheeses/findByTags](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-findbytags-get.md): Find cheeses by tags
- [GET /cheeses/{cheeseId}](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-cheeseid-get.md): Get cheese by ID
- [POST /cheeses/{cheeseId}](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-cheeseid-post.md): Update cheese with form data
- [DELETE /cheeses/{cheeseId}](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-cheeseid-delete.md): Delete a cheese
- [POST /cheeses/{cheeseId}/uploadImage](https://sourcey.com/examples/docs-showcase/api/operations/operation-cheeses-cheeseid-uploadimage-post.md): Upload a cheese image
- [GET /store/inventory](https://sourcey.com/examples/docs-showcase/api/operations/operation-store-inventory-get.md): Get store inventory
- [POST /store/order](https://sourcey.com/examples/docs-showcase/api/operations/operation-store-order-post.md): Place a cheese order

Excerpt from CheesestoreDownload file

Plain HTML does most of the work.

Pages render at build time. The browser gets HTML, CSS and a small script for search and interactive controls.

Run a fresh audit

Lighthouse Report

100

Performance

100

Accessibility

100

Best Practices

100

SEO

Cheese Store quickstartMobile Lighthouse 13.5 · 8 October 2026

Write the guide beside the reference.

Component reference

webhooks.md

:::steps
1. Register your endpoint
   Choose the events and your receiving URL.
2. Verify each delivery
   Check `X-Cheese-Signature` before processing.
3. Acknowledge the event
   Return `200` and process the work asynchronously.
:::

:::accordion{title="Signature verification failing?"}
Verify the raw request body, before parsing JSON.
:::

Preview

Features

What ships with Sourcey.

Reference inputs

Keep the definitions and comments you already maintain.

OpenAPI 2.0 through 3.2
Endpoints, schemas and request examples in ten languages. OpenAPI 3.2 support includes QUERY operations, hierarchical tags and response summaries.
MCP server docs
Tools, resources, and prompts rendered as browsable reference. JSON-RPC, TypeScript, and Python code samples.
C++ and Java via Doxygen
Keep API comments with your code. Sourcey renders Doxygen’s XML as searchable reference; Moxygen is included.
Go and Rust
Go package docs from the Go toolchain, without a Doxygen detour. Rust crate docs and doctests from rustdoc JSON, through the bundled sourcey-rustdoc helper.
Markdown and MkDocs
Steps, cards, accordions and tabbed code in Markdown. Import navigation, snippets, admonitions and assets from mkdocs.yml.

Development and CI

Work in your editor, preview locally and use your existing pipeline.

TypeScript config
Sources, navigation, branding and output in one sourcey.config.ts. defineConfig() supplies autocomplete and type checking.
Vite dev server
Hot reload for components and CSS, with page refreshes when specs or Markdown change.
Instant search
Fuzzy search across pages, operations and parameters. Cmd+K opens it. The index ships with your static files and works offline.
Install anywhere
npx sourcey with no global install, or install once via Homebrew, Docker, or Nix.
Builds in CI
Run sourcey build in GitHub Actions or any pipeline. Rebuild the docs with each source change.

Publishing and ownership

Static files, project branding and the formats your readers need.

Static HTML output
HTML, CSS and scripts for search and controls. Serve them from GitHub Pages, Vercel, S3 or your own infrastructure.
Four theme presets
Default with sidebar and page outline, Minimal for a single column, API-first for reference beside examples, Reader for long documents. Your fonts, colours and CSS.
Dark mode
Follows the system preference until a reader chooses. Saves that choice and supports separate light and dark logos.
OG image cards
Social preview images generated during the build from page titles, descriptions and project branding.
Readable docs and discovery
Markdown for pages, operations and schemas, plus llms.txt and a full-text export. Optional OpenAPI downloads, ARD and API catalogs. The separate docs MCP server reads a built directory. Retrievers for LangChain and n8n read these files.

Compare

How Sourcey compares.

All comparisons

Compare the build, the finished site, and the work involved in switching.

Docs platforms

Open-source tools

Writing

All essays

Own your docs.

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

View on GitHub Read the docs

Fork the demo

Docs from the source.

Empty directory to shipped docs.

Configure

Write

Ship

Technical docs can look this good.

Built with Sourcey

Reference from your specs and code.

Search down to the endpoint.

Give your agent the reference.

Plain HTML does most of the work.

Write the guide beside the reference.

What ships with Sourcey.

Reference inputs

OpenAPI 2.0 through 3.2

MCP server docs

C++ and Java via Doxygen

Go and Rust

Markdown and MkDocs

Development and CI

TypeScript config

Vite dev server

Instant search

Install anywhere

Builds in CI

Publishing and ownership

Static HTML output

Four theme presets

Dark mode

OG image cards

Readable docs and discovery

How Sourcey compares.

Docs platforms

Open-source tools

Writing

Why We Care What the Docs Look Like

You Don't Own Your Docs

Your Docs Have a Second Reader Now

Own your docs.