Skip to content

Supported frameworks

Manuscrio exports a finished static build from three documentation frameworks. Each has its own page:

FrameworkRequirement
DocusaurusAny theme built on the standard theme-doc-* markup, which is Docusaurus’s published theming contract.Docusaurus to PDF
StarlightThe Astro Starlight documentation theme.Starlight to PDF
MkDocsThe Material theme. MkDocs itself prescribes no markup, so a theme supplies all of it; the built-in theme emits unrelated markup and is not supported.MkDocs to PDF

The framework is detected from the built pages, so the ordinary command names no framework at all:

Terminal window
manuscrio-pdf inspect ./build

The report’s framework field names the adapter that read the build. Pass --framework docusaurus, --framework starlight, or --framework mkdocs to skip detection when you are diagnosing an unusual build. When nothing is recognised, Manuscrio says so and names the supported frameworks rather than reporting an empty site.

See each integration run end to end in its public GitHub example repository. Each repository contains a complete documentation project and a GitHub Actions workflow that builds the site, exports its static output with Manuscrio, and publishes the resulting PDFs as a downloadable workflow artifact:

These repositories are runnable examples, not plugins. Copy the project or just its workflow; they are GitHub Actions only, so see Run in CI for the container form other CI systems use.

One chapter opener from a real manual exported from each framework’s own documentation. The design does not change with the framework; what changes is what the framework could tell Manuscrio about itself.

A chapter opening in a manual exported from a Docusaurus build
DocusaurusPlaywright docs, Getting Started · garnet · 51 pages
A chapter opening in a manual exported from a Starlight build
StarlightAstro docs, How-to recipes · malachite · 135 pages
A chapter opening in a manual exported from a MkDocs Material build
MkDocsMaterial docs, Setup · lapis · 121 pages

The Docusaurus page carries the site’s own logo in its running header. The other two carry nothing, because logo discovery is not implemented for those adapters yet — the difference the table below records, visible in the output.

The three frameworks do not describe their documentation to the same depth, and Manuscrio reports what each one actually provides instead of inventing the rest.

DocusaurusStarlightMkDocs
Editions per localeyesyesyes
Editions per versionyesnono
Editions per plugin instanceyesnono
Navbar sectionsyesnono
--scope editionyes *yesyes
--scope sectionyes *nono
--scope sidebar-rootyesyesyes
Logo discovered from the buildyesnot yetnot yet
Sidebar root IDsstable, by routepositionalpositional

* A Docusaurus edition containing a sidebar that belongs to no navbar section is refused at both edition and section scope, and exports at --scope sidebar-root. See UNASSIGNED_DOCUMENTATION_SET.

Every row above is explained on the framework’s own page, alongside the commands it changes.