by sourcey
Precision documentation from OpenAPI, MCP, Doxygen, and Markdown guides. Static HTML you own.
# Add to your Claude Code skills
git clone https://github.com/sourcey/sourceyGuides for using mcp servers skills like sourcey.
Last scanned: 5/15/2026
{
"issues": [
{
"type": "npm-audit",
"message": "fast-uri: fast-uri vulnerable to path traversal via percent-encoded dot segments",
"severity": "high"
}
],
"status": "WARNING",
"scannedAt": "2026-05-15T06:56:37.719Z",
"semgrepRan": false,
"npmAuditRan": true,
"pipAuditRan": true
}Docs straight from the source.
Sourcey tells the whole product story. It turns specs, code, rich guides, changelog, roadmap pages, examples, and portable context files 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
QUERY operations, response summaries, hierarchical tags, deviceAuthorization OAuth, querystring parameters, and $self-aware refs for multi-document APIsNo comments yet. Be the first to share your thoughts!
Top skills in this category by stars
godoc.json snapshots for JS-only docs hosts. No Doxygen detoursourcey.config.ts with defineConfig() autocomplete; theme, navbar, CTA buttons, footerThe full Sourcey binary handles OpenAPI, Doxygen, godoc, MCP, and Markdown sources.
| Path | Command | Requires |
|----------|----------------------------------------------------|-------------------|
| npm | npm install -g sourcey | Node 20+ |
| Homebrew | brew tap sourcey/tap && brew install sourcey | macOS / Linuxbrew |
| Docker | docker run -v "$PWD":/docs sourcey/sourcey | Docker |
| Nix | nix run github:sourcey/sourcey | Nix (flakes) |
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.
| Path | Command |
|----------|---------|
| Go | go install github.com/sourcey/sourcey/go/sourcey-godoc/cmd/sourcey-godoc@latest |
| Homebrew | brew install sourcey/tap/sourcey-godoc |
| Scoop | scoop bucket add sourcey https://github.com/sourcey/scoop-bucket && scoop install sourcey-godoc |
# 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",
navigation: {
tabs: [
{ tab: "API Reference", openapi: "./openapi.yaml" },
],
},
});
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). See docs/configuration.md for theme, navbar, footer, logo, and full tab options.
Render Go package docs as a tab inside your Sourcey site, branded and styled with the rest of your documentation. Native toolchain extraction (go list + go/parser + go/doc) feeds the same renderer as your OpenAPI, MCP, and Markdown tabs, so signatures, examples from *_test.go, and source links sit alongside your guides instead of bouncing readers to pkg.go.dev.
{ tab: "Go API", godoc: "." }
The shorthand expands to { module: ".", packages: ["./..."], mode: "auto", includeTests: true }. Live mode uses the host Go toolchain; snapshot mode reads a committed godoc.json and needs no Go on the build host. See docs/configuration.md for packages, mode, goEnv, sourceBasePath, and includeUnexported.
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
Run sourcey <command> --help for flags.
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.