mkdocs-print-site-plugin

What it is and what it does

This is a MkDocs plugin that solves the problem of exporting entire documentation sites to a single printable format. Instead of printing individual pages, it creates a combined print page at /print_page/ that merges all your site content into one document, which you can then export to PDF via your browser or save as standalone HTML. It works with mkdocs-material and readthedocs themes, and integrates with plugins like tags and autorefs.

The plugin is lightweight with no external dependencies beyond mkdocs-material, supports modern Python versions (3.8 through 3.11), and offers customization options including cover pages and PDF pagination. Setup is straightforward: install via pip, add two lines to your mkdocs.yml configuration, and the print page becomes available immediately.

Use it for:

• Export full API documentation to PDF for offline distribution or printing.
• Create standalone HTML archives of documentation for backup or sharing without a web server.
• Generate printable user manuals from MkDocs-based documentation sites.
• Combine multiple documentation pages into a single document for easier searching and reading.
• Support dark theme printing with mkdocs-material by leveraging the plugin's theme integration.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

MkDocs plugin that generates a combined print page of your entire site for easy export to PDF or standalone HTML.

Yes. The plugin is actively maintained, has no known vulnerabilities, installs with low friction, and solves a genuine documentation workflow problem. It's well-suited for teams using MkDocs who need to export documentation to PDF or HTML. The permissive MIT license removes any licensing concern.

Install

mkdocs-print-site-plugin on PyPI

pip install mkdocs-print-site-plugin

uv add mkdocs-print-site-plugin

poetry add mkdocs-print-site-plugin

Installing mkdocs-print-site-plugin

Before you install

Low friction install with a single runtime dependency (mkdocs-material). Active maintenance with recent commits and no known vulnerabilities.

License in practice

MIT license is permissive; you can use this plugin freely in commercial and private projects with minimal restrictions.

Quickstart

pip install mkdocs-print-site-plugin

Then add to mkdocs.yml:
plugins:
  - search
  - print-site

Navigate to /print_page/ to access the combined page.

Requires Python 3.8 or later; print-site plugin must be placed at the bottom of your plugins list in mkdocs.yml so other plugin changes are included.

Verify before relying

• Whether PDF export quality and pagination work reliably across all browser implementations.
• Performance characteristics when exporting very large documentation sites (thousands of pages).
• Compatibility with custom MkDocs themes beyond mkdocs-material and readthedocs.

Package facts

Evidence: mkdocs_print_site_plugin-2.8-py3-none-any.whl

Keywords: mkdocs, plugin, print, pdf

Tags

More Text Processing packages