Changelog
What changed in each version of Postdoc, newest first. The version beside the menu is the latest release.
1.0.0 – 22 November 2026
Added
- Storymaps: stories told in steps beside a map that moves as the reader scrolls, with tracks on a timeline, satellite layers that change with the date, figures, legends and story pages.
- Page checks in
postdoc test: accessibility against WCAG 2.2 AA with axe-core, in light and dark mode, the keyboard, larger and more widely spaced text, and moving between pages, at the widths you choose, with a report. postdoc check, which checks the configuration, compiles every page and checks every internal link and anchor in seconds, without a browser, andpostdoc screenshot.- Node.js playgrounds and Python notebooks, whose code readers run on the page.
- Themes, whose layouts and files a project overrides one by one, and a layout named in a page's front matter.
- Diagrams with Mermaid, callouts that hold other blocks, titles for code blocks, and links to
.mdfiles that lead to their pages. - An
llms.txtfile and a copy of every Markdown page in a build, for AI agents. --portforpostdoc runandpostdoc preview, and--out-dirforpostdoc build,postdoc preview,postdoc testandpostdoc screenshot.apidocs.requireName, which makes API pages only of the files with a@namecomment, andexampleHtml, each@examplecompiled as Markdown.check.ignoreLinks, for paths of the domain that another site serves, and awarningslist inpostdoc check --json.
Changed
- The configuration names its folders with
baseDir,contentPath,testsPathandoutputPath, as Project structure shows. Layouts and includes are inpostdoc/layoutsandpostdoc/includesby default, instead ofpagesandincludes. apidocs.layoutis nowapidocs.layoutName,markdown.options.syntaxHighlightismarkdown.syntaxHighlight, and_import()in a layout isimportModule().- The settings of 0.3.0-preview4 still work, with a warning: a configuration without
baseDirkeeps its folders in the project's folder and has no theme. See Configurations of 0.3.0-preview4. - Comments with an
@ignoretag are left out of API pages. postdoc testneeds Nightwatch 3.15 or newer, installed in the project. It runs your tests first and the page checks after them, in a Nightwatch run of their own that writes no report files, and leaves out HTML files that aren't pages of Postdoc.- Postdoc needs Node.js 22.18 or newer, and builds with Vite 8 instead of 5, so the plugins in
vite.pluginshave to support it. -hshows a command's help, and no longer stands for--host.postdoc run --opentakes the page to open, instead of a browser.- Code is coloured by shiki 4.5, in the
github-light-high-contrastandgithub-dark-high-contrastthemes by default, whose colours pass the page checks. - Pagefind starts only when a page is indexed, and where it can't run, a site is built without a search index.
Removed
- The BrowserStack settings, and
postdoc run --remote, which used them. The vite-plugin-browserstack package opens the dev server on BrowserStack's devices instead.
Fixed
- A page added to a project made by
postdoc initfailed to compile, and the project's links didn't lead to its headings. - Moving between pages dropped the styles that scripts had added to the page.
0.3.0-preview4 – 21 March 2024
- Markdown extensions: code coloured by shiki, code groups, which are off unless they're turned on, callouts, tables with merged cells, and math with KaTeX.
0.3.0-preview3 – 15 March 2024
- Updates to the default theme, and a fix to moving between pages.
0.3.0-preview2 – 12 March 2024
- Small changes to moving between pages.
0.3.0-preview – 12 March 2024
- Links that start with
/to the project's own files, such as/src/css/base.css, are made relative to each page, so Vite bundles them for pages in subfolders too. - The dev server compiles the API docs again when their source changes.
postdoc initno longer copies anode_modulesfolder into the project.
0.2.0-preview – 26 December 2023
postdoc testpasses its options on to Nightwatch.postdoc create pageswrites Markdown files, in subfolders too.postdoc initdoesn't overwrite a folder that exists, and sets up the current one with--name ..- A verbose option for the log.
0.1.3 – 29 May 2023
- A fix to loading EJS.
0.1.2 – 29 May 2023
- Updated dependencies.
0.1.1 – 29 May 2023
- Pages can be EJS files as well as Markdown, and
includeworks withoutawait. postdoc initasks for the project's name when it isn't given.postdoc run --open, andNO_COLORsupport.- Moving between pages keeps their stylesheets, and runs a page's scripts once.
0.1.0 – 22 June 2021
- The first version on npm.