mkdocs-print-site-plugin 2.8


pip install mkdocs-print-site-plugin

  Latest version

Released: Aug 03, 2025
Navigation
Project Links
Meta
Author: Tim Vink
Requires Python: >=3.8
Classifiers

Operating System
  • OS Independent

Programming Language
  • Python
  • Python :: 3
  • Python :: 3.8
  • Python :: 3.9
  • Python :: 3.10
  • Python :: 3.11

License
  • OSI Approved :: MIT License

Topic
  • Documentation
  • Text Processing

Actions Status PyPI - Python Version PyPI PyPI - Downloads codecov GitHub contributors PyPI - License

mkdocs-print-site-plugin

MkDocs plugin that adds a print page to your site that combines the entire site, allowing for easy export to PDF and standalone HTML. See demo.

Features :star2:

  • Support for mkdocs-material theme, including features like instant loading, dark color themes and certain plugins (f.e. the tags plugin)
  • Support for readthedocs theme
  • Support for pagination in PDFs
  • Many options to customize appearance
  • Option to add a cover page
  • Lightweight, no dependencies
  • Support for the autorefs plugin

Setup

Install the plugin using pip3:

pip3 install mkdocs-print-site-plugin

Next, add the following lines to your mkdocs.yml:

plugins:
  - search
  - print-site

⚠️ Make sure to put print-site to the bottom of the plugin list. This is because other plugins might alter your site (like the navigation), and you want these changes included in the print page.

If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set.

Usage

  • Navigate to /print_page/ or print_page.html
  • Export to standalone HTML (see export to HTML)
  • Export to PDF using your browser using File > Print > Save as PDF (see export to PDF)

Documentation

Available at timvink.github.io/mkdocs-print-site-plugin.

Contributing

Contributions are very welcome! Start by reading the contribution guidelines.

2.8 Aug 03, 2025
2.7.3 May 07, 2025
2.7.2 Mar 31, 2025
2.7.1 Mar 14, 2025
2.7.0 Mar 13, 2025
2.6.0 Sep 12, 2024
2.5.0 May 31, 2024
2.4.1 May 08, 2024
2.4.0 Apr 10, 2024
2.3.6 Aug 28, 2023
2.3.5 Jun 12, 2023
2.3.4 Jun 01, 2022
2.3.3 Apr 19, 2022
2.3.2 Mar 02, 2022
2.3.1 Feb 16, 2022
2.3 Jan 28, 2022
2.2.5 Jan 18, 2022
2.2.4 Jan 14, 2022
2.2.3 Jan 12, 2022
2.2.2 Jan 09, 2022
2.2.1 Dec 24, 2021
2.2 Dec 11, 2021
2.1 Dec 02, 2021
2.0.3 Oct 20, 2021
2.0.2 Oct 07, 2021
2.0.1 Oct 02, 2021
2.0.0 Sep 15, 2021
1.3.0 Sep 13, 2021
1.2.4 Sep 07, 2021
1.2.3 May 19, 2021
1.2.2 May 11, 2021
1.2.1 May 10, 2021
1.2.0 May 10, 2021
1.1.0 Feb 22, 2021
1.0.0 Dec 21, 2020
0.8.2 Oct 21, 2020
0.8.1 Oct 08, 2020
0.8 Oct 07, 2020
0.7.1 Oct 04, 2020
0.7 Oct 01, 2020
0.6 Sep 21, 2020
0.5.3 Sep 19, 2020
0.5.2 Sep 16, 2020
0.5.1 Sep 15, 2020
0.5 Sep 15, 2020
0.4 Sep 12, 2020
0.3.1 Sep 10, 2020
0.3 Sep 09, 2020
0.2 Sep 08, 2020
0.1 Sep 05, 2020

Wheel compatibility matrix

Platform Python 3
any

Files in release

Extras: None
Dependencies:
mkdocs-material (>=7.3.0)