Introduction · Specistry Docs

Specistry turns OpenAPI contracts and authored Markdown into a self-hosted developer portal, built ahead of time.

You bring three things: an OpenAPI contract (optional), a folder of Markdown pages (optional), and a specistry.config.ts. The CLI validates them, builds one immutable artifact, and the Node reader serves it from your infrastructure.

TutorialYour first siteInstall, write a page, build. Ten minutes.7 recordingsAll tutorialsPages, API reference, media, SDKs, versions, CI.ReferenceComponentsCallout, Steps, Cards, Tabs, CodeGroup.5 startersTemplatesCopy a working project and edit it.

How it fits together

pipeline

openapi.yaml ─┐
docs/*.md    ─┼─▶ specistry validate ─▶ specistry build ─▶ .specistry/artifacts ─▶ reader
config.ts    ─┘                         specistry check   (quality gate)

What it deliberately does not do

Execute anything you write — content is data, never code
Infer SDK methods you did not map
Proxy playground requests through a server
Ingest AsyncAPI or GraphQL
Run as a hosted service

NoteConfiguration is code. Content is data.

specistry.config.ts is trusted build code — review it like a build script. Page bodies and API descriptions are untrusted and are only ever rendered as text.