Add PDF export to the HaLOS docs - #33
Merged
Merged
Conversation
Add mkdocs-print-site-plugin to generate a combined print page with a cover page and export banner, plus a printer icon on every page linking to it. Readers export the guide to PDF via the browser's print dialog. No new CI dependencies; the strict build is unaffected. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Readers want an offline/printable copy of the guide. This adds a one-click path from any page to a PDF.
How
Uses mkdocs-print-site-plugin: a printer icon on every page (top-right, beside the edit pencil) links to a combined
/print_page/that aggregates the whole guide with a cover page and an auto-numbered TOC. A banner on that page instructs the reader to export via File > Print > Save as PDF — the browser renders the PDF, so diagrams and CSS come out exactly as on screen.This approach adds no CI dependencies —
uv syncpicks up the new package and the existing strict build is unchanged. Same change as the HALPI2 docs (hatlabs/halpi2#24).Verified
uv run mkdocs build --strict→ exit 0, no new warnings🤖 Generated with Claude Code