Docs straight from the source.

Sourcey tells the whole product story. It turns specs, code, rich guides, changelog, roadmap pages, examples, and agent-readable context from your project into static HTML you can deploy anywhere.

No dashboard. No runtime. No API calls to render your own documentation.

npx sourcey init

Live demo · Documentation · GitHub

• OpenAPI 2.0, 3.0, 3.1, and 3.2: full spec coverage including QUERY operations, response summaries, hierarchical tags, deviceAuthorization OAuth, querystring parameters, and $self-aware refs for multi-document APIs
• API reference from OpenAPI: endpoints, parameters, request/response schemas, auto-generated code samples in 10 languages (cURL, JavaScript, TypeScript, Python, Go, Ruby, Java, PHP, Rust, C#)
• MCP server documentation: tools, resources, prompts rendered as browsable reference with JSON-RPC, TypeScript, and Python code samples. Color-coded method types, annotation badges, connection config cards
• Rich guides: markdown pages with steps, cards, accordions, syntax-highlighted code blocks, and prose alongside your API reference
• Product story pages: changelog, roadmap pages, examples, reference material, search, and agent-readable output in one source-owned site
• C++ and Doxygen: feed Doxygen XML output, get modern searchable API docs. No new parser, no four-tool Breathe/Exhale/Sphinx pipeline
• Go and godoc: native package documentation extracted from Go source via the toolchain. Render Go modules as Sourcey tabs, generate standalone static Go docs sites, or commit godoc.json snapshots for JS-only docs hosts. No Doxygen detour
• llms.txt generation: auto-generate llms.txt and llms-full.txt alongside your HTML. Docs serve developers and AI agents from one build
• TypeScript config: sourcey.config.ts with defineConfig() autocomplete; theme, navbar, CTA buttons, footer
• Theme presets: default (sidebar + TOC), minimal (single column), api-first (Stripe-style three column); colors, fonts, layout dimensions, and custom CSS on top
• Vite dev server: SSR hot reload on every component and CSS change; spec and markdown changes trigger instant refresh
• Dark mode: semantic design tokens, light/dark logo variants, localStorage persistence
• Client-side search: instant fuzzy search across all pages and API operations; Cmd+K
• Static HTML output: no framework runtime, no vendor lock-in. Deploy to GitHub Pages, Vercel, Netlify, S3, anywhere
• Open source: AGPL-3.0. Self-host, fork, extend. Your docs, your infrastructure

The full Sourcey binary handles OpenAPI, Doxygen, godoc, MCP, and Markdown sources.

Then sourcey init to scaffold a new project, or sourcey build against an existing one. See docs/install.md for full Docker invocations (init / dev / build), the --host flag for containerized dev, Linuxbrew notes, and Nix profile install.

For Go-only consumers without a JavaScript toolchain, sourcey-godoc ships as a separate native binary. It produces static Go docs sites or portable godoc.json snapshots.

# From a single OpenAPI spec
sourcey build api.yaml -o docs/

# Multi-page site (reads sourcey.config.ts)
sourcey build -o docs/

# Dev server with hot reload
sourcey dev

Create sourcey.config.ts in your project root:

import { defineConfig } from "sourcey";

export default defineConfig({
  name: "My API",
  theme: {
    preset: "default",  // "default" | "minimal" | "api-first"
    colors: {
      primary: "#6366F1",
      light: "#818CF8",
      dark: "#4F46E5",
    },
  },
  logo: "./logo.png",
  navigation: {
    tabs: [
      {
        tab: "Documentation",
        groups: [
          {
            group: "Getting Started",
            pages: ["introduction", "quickstart", "authentication"],
          },
        ],
      },
      {
        tab: "API Reference",
        openapi: "./openapi.yaml",
      },
      {
        tab: "MCP Server",
        mcp: "./mcp.json",
      },
    ],
  },
  navbar: {
    links: [{ type: "github", href: "https://github.com/you/repo" }],
    primary: { type: "button", label: "Dashboard", href: "https://app.example.com" },
  },
  footer: {
    socials: { github: "https://github.com/you/repo" },
  },
});

Each tab is an openapi spec, an mcp snapshot, a doxygen directory, a godoc Go module, or groups of markdown pages. Pages are referenced by slug (e.g. "quickstart" resolves to quickstart.md).

Add a Go module as a tab and Sourcey extracts package docs natively (no Doxygen pipeline):

{
  tab: "Go API",
  godoc: {
    module: ".",
    packages: ["./internal/core/...", "./cmd/..."],
    // sourceBasePath: "go/my-module" // repo-relative prefix for source links when module is not at repo root
    // mode: "auto"   // default; live when Go is available, snapshot otherwise
    // includeTests: true       // examples from *_test.go (default)
    // includeUnexported: false // hide unexported symbols (default)
  },
}

The string shorthand is godoc: "." and expands to { module: ".", packages: ["./..."], mode: "auto", includeTests: true }.

editBasePath remains the global base for Markdown "Edit this page" links. Use godoc.sourceBasePath only when Go source files live under a different repository prefix than the docs source.

Live mode invokes go list + go/parser + go/doc against the host Go toolchain. To pin a build environment for reproducibility, set goEnv: { GOOS, GOARCH, tags }.

Snapshot mode reads a committed godoc.json and needs no Go on the build host. Generate it with:

sourcey godoc --module . --packages './...' --out docs/godoc.json

then point the tab at it:

{
  tab: "Go API",
  godoc: { mode: "snapshot", snapshot: "./docs/godoc.json" },
}

The extractor is also a standalone Go CLI for projects that want a native Go docs generator without installing the full Sourcey npm package:

go install github.com/sourcey/sourcey/go/sourcey-godoc/cmd/sourcey-godoc@latest
sourcey-godoc generate --module . --packages './...' --out site
sourcey-godoc snapshot --module . --packages './...' --out docs/godoc.json

Guides support rich components in standard markdown:

<Steps>
  <Step title="Install">Run `npm install sourcey`</Step>
  <Step title="Configure">Create `sourcey.config.ts`</Step>
  <Step title="Build">Run `sourcey build`</Step>
</Steps>

<CardGroup cols={2}>
  <Card title="API Reference" icon="book" href="/api">Full endpoint docs</Card>
  <Card title="Guides" icon="map" href="/docs">Step-by-step tutorials</Card>
</CardGroup>

<AccordionGroup>
  <Accordion title="How does auth work?">We use API keys and OAuth2.</Accordion>
</AccordionGroup>

All visual configuration lives under theme. Colors, fonts, layout dimensions, and a preset that controls page structure:

theme: {
  preset: "api-first",
  colors: { primary: "#f59e0b", light: "#fbbf24", dark: "#d97706" },
  fonts: { sans: "'Lexend', sans-serif", mono: "'Fira Code', monospace" },
  layout: { sidebar: "16rem", content: "48rem" },
  css: ["./brand.css"],
}

Presets control layout structure: "default" (sidebar + TOC), "minimal" (single centered column), "api-first" (three-column with persistent code panels). Everything else applies on top.

sourcey dev                       Dev server (reads sourcey.config.ts)
sourcey build                     Build site (reads sourcey.config.ts)
sourcey build api.yaml            Quick build from a single spec
sourcey validate api.yaml         Validate a spec file
sourcey godoc --out godoc.json    Snapshot a Go module's docs to JSON
sourcey-godoc generate --out site Standalone Go CLI for static godoc sites

git clone https://github.com/sourcey/sourcey.git
cd sourcey && npm install
npm run build && npm test
cd go/sourcey-godoc && go test ./... && go vet ./...

# Run the demo site
cd demo && npx tsx ../src/cli.ts dev

AGPL-3.0. Free to use, self-host, and modify. If you run Sourcey as a hosted service, you open-source your stack.

Commercial licensing available; contact sourcey.com.