Skip to content

Manuscrio documentation

Inspect a completed documentation build and export polished PDF manuals locally or in CI.

Manuscrio works from the static output of a successful documentation build. It does not need your source repository, install a source plugin, or upload documentation to a hosted service.

  1. Inspect — discover editions, sections, sidebar roots, pages, and diagnostics before rendering.
  2. Export — write complete PDFs with covers, contents, numbered chapters, running furniture, and bookmarks.
  • Docker or Podman, and Node 20.19 or later if you want the manuscrio command rather than writing docker run yourself.
  • A successful build directory: build/ for Docusaurus, dist/ for Starlight, site/ for MkDocs.
  • A writable output directory.
  • Optionally, a signed Manuscrio licence. Without one, the same complete export runs in Evaluation Mode.

Manuscrio names the parts of a documentation site precisely, because the names decide how many PDFs you get and what is in each one.

Term Meaning
Site Build The finished static output of a documentation build. This is the only input.
Documentation Edition The documentation for one plugin instance, locale, and version — identified as plugin:locale:version. A manual never mixes two of them.
Documentation Section A documentation-bearing navbar entry and the pages it covers. Only Docusaurus has this level.
Sidebar Root A top-level sidebar entry and everything beneath it.
Manual One documentation unit exported as one PDF.
Manual Scope Which of the three boundaries above becomes a manual: edition, section, or sidebar-root. This is the control for cutting a large edition into PDFs a reader can use.

Run your first export →