Repolode
Submit
timvink

timvink/mkdocs-print-site-plugin

A MkDocs plugin that adds a print page combining all site pages for easy export to PDF or standalone HTML.

View on GitHubWebsite
Stars
189
Forks
30
Open issues
13
Last commit
3 days ago

What is it?

mkdocs-print-site-plugin is a plugin for MkDocs, the Python static site generator for documentation. It generates an extra page that concatenates every page of a site into one document, so the whole documentation can be saved as a single PDF or a standalone HTML file.

The print page is served at /print_page/ or print_page.html. PDFs are produced by printing that page from a browser, and the plugin includes pagination for PDF output and options for a cover page and appearance. It works with the mkdocs-material, mkdocs-materialx and readthedocs themes, and supports the autorefs plugin. Its only dependency is mkdocs.

Add the plugin to the bottom of the plugins list in mkdocs.yml so that changes made by other plugins to navigation are included in the combined output.

Key features

  • 01Adds a print page that combines all site pages into one document
  • 02Exports to PDF via the browser print dialog or to standalone HTML
  • 03Supports pagination in PDFs and an optional cover page
  • 04Works with mkdocs-material, mkdocs-materialx and readthedocs themes
  • 05Supports the autorefs plugin
  • 06Only mkdocs is required as a dependency

Use cases

  • Offering a complete offline PDF version of a project's documentation site
  • Distributing a single standalone HTML file of documentation
  • Producing printable manuals from an MkDocs-based docs site

Quick start

  1. 1

    Install the plugin with pip

    pip3 install mkdocs-print-site-plugin
  2. 2

    Add print-site to the bottom of the plugins list in mkdocs.yml

  3. 3

    Open /print_page/ or print_page.html on your site to view the combined print page

Things to know

  • Print page export to PDF relies on your browser's print function.

In collections

PDF, OCR & document toolsStatic site generators & documentation tools

Topics

#mkdocs#mkdocs-plugin#pdf#documentation#static-site#python#pdfs#print

FAQ

What is mkdocs-print-site-plugin?
A MkDocs plugin that adds a print page combining all site pages for easy export to PDF or standalone HTML. mkdocs-print-site-plugin is a plugin for MkDocs, the Python static site generator for documentation. It generates an extra page that concatenates every page of a site into one document, so the whole documentation can be saved as a single PDF or a standalone HTML file.
Is mkdocs-print-site-plugin free to use? What license does it have?
mkdocs-print-site-plugin is open source under the MIT license. Check the license terms before using it in commercial products.
Is mkdocs-print-site-plugin still maintained?
Actively maintained. The last commit to mkdocs-print-site-plugin was on Nov 4, 2026.
What can I use mkdocs-print-site-plugin for?
Offering a complete offline PDF version of a project's documentation site Distributing a single standalone HTML file of documentation Producing printable manuals from an MkDocs-based docs site
How do I install mkdocs-print-site-plugin?
Install the plugin with pip: pip3 install mkdocs-print-site-plugin Add print-site to the bottom of the plugins list in mkdocs.yml Open /print_page/ or print_page.html on your site to view the combined print page
Where can I get mkdocs-print-site-plugin?
The source code and installation instructions are on GitHub: https://github.com/timvink/mkdocs-print-site-plugin

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects