Documentation site generator
Create joyful documentation sites.
Write pages in Markdown and layouts in plain HTML. Postdoc builds a fast static site that changes pages without reloading, can work offline, and is tested for accessibility on every page.
Features
Everything a documentation site needs, in one CLI.
-
Storymaps
A map that moves as readers scroll, with tracks that draw themselves and layers that change by date.
-
Accessibility, tested on every page
postdoc testchecks every page against WCAG 2.2 AA, in light and dark mode. -
Layouts in plain HTML
Pages in Markdown, layouts in HTML with a few EJS tags. No Vue or React to learn.
-
Markdown with extras
Syntax highlighting, code groups, callouts, Mermaid diagrams and math, all built in.
-
API docs and search
An API reference from your JSDoc comments, and search that runs in the browser.
-
Navigation without reloads
Static HTML pages that change without a reload, and announce themselves to screen readers.
See it in action
Ship docs, not complexity
postdoc init creates a working site
with layouts, dark mode, search and sample pages, so
you can start writing straight away.
postdoc test builds the site and checks
every page in a real browser. Your own Nightwatch tests
run in the same pass, and a failure fails the CI job.
The build is plain static files, so it runs on GitHub Pages, Netlify, Vercel or any web server, with no runtime and no lock-in.