Supported frameworks
Manuscrio exports a finished static build from three documentation frameworks. Each has its own page:
| Framework | Requirement | |
|---|---|---|
| Docusaurus | Any theme built on the standard theme-doc-* markup, which is Docusaurus’s published theming contract. | Docusaurus to PDF |
| Starlight | The Astro Starlight documentation theme. | Starlight to PDF |
| MkDocs | The 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:
manuscrio-pdf inspect ./buildThe 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.
Working integrations on GitHub
Section titled “Working integrations on GitHub”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:
- Working Docusaurus integration on GitHub —
manuscrio/docusaurus-pdf-export - Working Starlight integration on GitHub —
manuscrio/starlight-pdf-export - Working MkDocs Material integration on GitHub —
manuscrio/mkdocs-pdf-export
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.
The same design, three frameworks
Section titled “The same design, three frameworks”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.
Getting Started · garnet · 51 pages
How-to recipes · malachite · 135 pages
Setup · lapis · 121 pagesThe 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.
What differs, and why it is visible
Section titled “What differs, and why it is visible”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.
| Docusaurus | Starlight | MkDocs | |
|---|---|---|---|
| Editions per locale | yes | yes | yes |
| Editions per version | yes | no | no |
| Editions per plugin instance | yes | no | no |
| Navbar sections | yes | no | no |
--scope edition | yes * | yes | yes |
--scope section | yes * | no | no |
--scope sidebar-root | yes | yes | yes |
| Logo discovered from the build | yes | not yet | not yet |
| Sidebar root IDs | stable, by route | positional | positional |
* 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.