# sourcey/sourcey

Precision documentation from OpenAPI, MCP, Doxygen, and Markdown guides. Static HTML you own.

Repository: https://github.com/sourcey/sourcey
Canonical: https://ross.abutalabs.com/products/sourcey
Homepage: https://sourcey.com
Language: TypeScript
License: AGPL-3.0
License Family: copyleft
Topics: api-documentation, developer-tools, docs, documentation, doxygen, openapi, openapi3, static-site-generator, typescript, openapi31, swagger, documentation-generator, godoc, llms-txt, mcp-server, openapi-documentation
Last push: 2026-08-25T13:43:00+00:00

## Health v2 (maintenance only)
Score: 97/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 99, release rhythm 92, longevity 100
- inputs: {"age_days": 3886, "days_push": 8, "days_rel": 52, "gap_med": 4, "n_releases_24m": 10}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1361, forks 331 (observed 2026-08-28T04:04:29.998866+00:00)

## What it is
Sourcey is a TypeScript-based static site generator that turns OpenAPI specs, MCP servers, Doxygen XML, godoc, rustdoc, and Markdown into a single static HTML documentation site you own. It renders everything at build time with no runtime, and also emits llms.txt context exports for AI retrieval workflows.

## Use cases
- generate static API reference docs from an OpenAPI spec
- document MCP server tools and resources as browsable reference
- build searchable C++ docs from Doxygen XML without Sphinx
- generate Go godoc or Rust rustdoc static documentation sites
- combine markdown guides with API reference in one docs site
- generate llms.txt files alongside HTML docs for AI agents
- self-host documentation on GitHub Pages or S3 without a vendor

## When to choose
- you want static HTML docs you fully own and can deploy anywhere
- you need API reference plus guides, changelog, and roadmap in one build
- you want agent-friendly output like llms.txt and a JSON search index
- you're tired of hosted docs platforms or heavy JS documentation frameworks

## When to avoid
- you need a hosted docs platform with collaborative editing
- you require runtime-rendered or server-side dynamic documentation
- your project is not Node.js/TypeScript based and you prefer a different ecosystem tooling

## Facets
- artifact type: cli-tool
- maturity: active
- function: static-site-generator, api-documentation, documentation, markdown, cli, search-engine
- domain: documentation, developer-tools, apis, web-development
- platform: cli, cross-platform
- tags: openapi, swagger, mcp, doxygen, godoc, rustdoc, llms-txt, static-docs, docs-generator, api-reference, nodejs

## Member repositories
- sourcey/sourcey (main) score 97

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:29.998866+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:41:36.345179+00:00, confidence not recorded.
  - readme: https://github.com/sourcey/sourcey (fetched 2026-08-28T04:04:29.998866+00:00, sha b7f31495578a)
  - homepage: https://sourcey.com (fetched 2026-08-29T11:59:47.141384+00:00, sha 01b08b8ceb7b)
  - site_page: https://sourcey.com/docs (fetched 2026-08-29T11:59:47.154644+00:00, sha 157d62bacb8c)
  - registry_npm: https://registry.npmjs.org/sourcey (fetched 2026-08-29T11:59:47.156321+00:00, sha 52c3e7a7b997)
  - site_page: https://sourcey.com/oss (fetched 2026-08-29T11:59:47.150876+00:00, sha 2c13cd7bda6a)
  - site_page: https://sourcey.com/releases/sha256-f54ae5559bef1aae2cdbacb1c26d5860eeb4459221b4469e67117cc1d09a01b8 (fetched 2026-08-29T11:59:47.152969+00:00, sha 555478a7b21f)
- Data as of 2026-08-30T08:39:29.467469+00:00.