API documentation developers actually use
Put guides and references side by side in one site, with clear code samples for people and Markdown for the coding agents that read your docs too.
Reference pages come from your OpenAPI spec today, next to guides written with code blocks and tabs. An interactive API playground is on the roadmap.
Code samples that read well
The blocks developers expect, rendered the same in the editor and on the published site.
Highlighted code blocks
Language-aware syntax highlighting, with a file name or title on every sample.
Tabs for each language
Show the same call in curl, JavaScript and Python, and let readers pick one.
Steppers and hints
Walk through authentication step by step, and flag breaking changes with warning hints.
Learn moreGuides and reference, one site
Keep the quickstart, the guides and the reference in separate spaces, published as tabs of one site.
Sections as tabs
Each space becomes a tab on the published site, with its own navigation.
Learn moreSearch everything
One ⌘K search covers guides and reference together.
Review API changes
Ship reference updates through change requests alongside the release they describe.
Learn moreGive coding agents better context
AI coding tools write code from your docs. Give them clean text, not scraped HTML.
Markdown for every page
Add .md to any page URL to get the Markdown version, ready to paste into a prompt.
Learn morellms.txt and llms-full.txt
A standard index for agents, plus the whole site in one file.
Learn moreMCP server
An MCP server for each site, so agents can query your docs as a tool.
Learn moreBuilt for API teams
References from your OpenAPI spec today; a playground to try them next.
OpenAPI blocks
Show one operation or all of them from your OpenAPI 3 spec — parameters, request bodies, responses and examples — re-read every few hours as it changes.
API playground
Let readers send test requests right from the reference page.
Frequently asked questions
Can Docsheaf generate API docs from an OpenAPI spec?
Yes. Add an OpenAPI block, point it at your spec’s URL (JSON or YAML, OpenAPI 3.0 or 3.1) or upload the file, then show one operation or all of them. Docsheaf reads the spec again every few hours, so the reference keeps up as it changes. Swagger 2.0 specs need converting to OpenAPI 3 first.
Can readers try endpoints from the docs?
An interactive playground is planned but not available yet. Code samples are easy to copy, and every page is available as Markdown.
Can I combine API docs with guides and tutorials?
Yes. Put each one in its own space and publish them all on one site. Each space becomes a tab, and site search covers all of them.
Why does API documentation matter for AI coding agents?
Coding agents generate integration code from what they read. Docsheaf serves every page as Markdown plus llms.txt, so agents get clean, current text instead of scraped HTML.
Can I automate updates to the reference?
Yes. Docsheaf’s REST API can create and update pages, so a release pipeline can push reference changes. Send them as change requests if you want a review step.
Accurate docs. Better answers.
Start writing for free, or talk to us about bringing your team and your existing docs.