The Postdoc story

Page content:

A storymap doesn't need a map. When its steps have a picture instead, the pictures stay in view where the map would be, and no map code is loaded at all.

Here is Postdoc's own feature tour told that way: the illustrations from the home page on one side, and on the other the commands you would actually run, typed out as you reach them.

Six features, six commands

Layouts in plain HTML

Write pages in Markdown and layouts in HTML with a few EJS tags. There's no Vue or React to learn, and the default theme can be overridden file by file.

sh
npx postdoc init --name my-docs
cd my-docs
npm start

Markdown with extras

Syntax highlighting, code groups, callouts, tables with merged cells, Mermaid diagrams and math are all built in.

sh
npx postdoc create page --name /guide/faq

Navigation without reloads

Pages are plain static HTML, yet moving between them doesn't reload. Postdoc swaps the content in place and announces each new page to screen readers.

sh
npx postdoc run --open /guide/index.html

Turn JSDoc comments into an API reference, and search every page with Pagefind, which runs in the browser without a server.

sh
npx postdoc build

Accessibility, tested on every page

postdoc test checks every page against WCAG 2.2 level AA with axe-core, in light and dark mode, and tries it with the keyboard and with larger text.

sh
npx postdoc test --headless

Offline-first

Install vite-plugin-pwa and turn on one setting, and the site becomes a progressive web app. Once readers have visited it, they can keep reading without a connection.

sh
npx postdoc preview --open

How this page is written

Each step is a heading with an image attribute, and everything under it — text, code blocks, anything else — is the step's content:

docs/guide/storymaps/postdoc.mdmd
::: storymap
### Layouts in plain HTML {image="/assets/website-builder.svg"}

Write pages in Markdown and layouts in HTML with a few EJS tags.

```sh
npx postdoc init --name my-docs
```
:::

That's the whole page. The reference has the attributes, and A saildrone in the Pacific is a story with a map.

Edit this page on GitHub