Repository navigation
manuscrio-pdf: export a built Docusaurus site to PDF manuals, plus llms.txt #13101
david-manm
started this conversation in
Plugins, Themes, Presets and Libs
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
I make this, so to be upfront: Manuscrio is commercial, self-hosted software. It runs without a licence in an evaluation mode that watermarks the PDFs, and the
llmscommand described below is free. Following the suggestion on [#12643](#12643), I'm sharing it here.manuscrio-pdfreads thebuilddirectory thatdocusaurus buildproduces and turns it into PDF manuals. It doesn't need a plugin in your site, access to your source, or a running server.It runs in a container, so you need Docker or Podman. The npm command just starts the container for you.
What it does with a Docusaurus build
--scope sectiongives one PDF per documentation navbar entry, for example a short API volume separate from a long Docs one.--scope sidebar-rootsplits further, by sidebar.<details>, code and math are all in the built HTML and come through.--hydrateruns the site's own scripts first, so@docusaurus/theme-mermaiddiagrams and<BrowserOnly>content reach the PDF too.llms.txt from the same build (free)
This writes
llms.txtin sidebar order,llms-full.txt, and a Markdown copy beside every page, ready to copy intobuild/before you deploy. It reads the pages as built, so partials and generated index pages are included, and every tab is kept under its label. It also putstheme-mermaiddiagrams back asmermaidcode blocks, recovered from the compiled MDX. It needs no licence and adds no watermark or attribution.Try it
Licensing
Evaluation mode needs no account and has no page limit; the PDFs carry a watermark and a footer line. An organization licence removes both. Licences are checked offline, so nothing calls home, and CI works without network access. Projects that are public under an OSI-approved licence, documentation included, can get an Open Source License at no cost.
Questions and bug reports welcome here.
All reactions