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 mkdocs-materialx theme
- Support for readthedocs theme
- Support for pagination in PDFs
- Many options to customize appearance
- Option to add a cover page
- Lightweight,
mkdocsis the only dependency - 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-siteto 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
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set.
Usage
- Navigate to
/print_page/orprint_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.
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-print-site-plugin 2.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_print_site_plugin-2.9.tar.gz | 233.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_print_site_plugin-2.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 255.5 kB
Release files / mkdocs_print_site_plugin-2.9.tar.gz
| Download URL | mkdocs_print_site_plugin-2.9.tar.gz |
|---|---|
| Size | 233.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fb7f749a73e606e97bec7f871d9fa55ea76ba6d806d7ce124c814ac2327f537a
|
|
BLAKE2b-256 checksum How to use checksums |
2f2021a0fcb3a9b631f7135227fd660fe38d7ebe293d7b763378a3dc4dbf7f87
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.
Transparency logRelease files / mkdocs_print_site_plugin-2.9-py3-none-any.whl
| Download URL | mkdocs_print_site_plugin-2.9-py3-none-any.whl |
|---|---|
| Size | 22.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bd26729160b5e2eec49f027448d1c54086f50b91ba5a0a5999d9d0e75938c345
|
|
BLAKE2b-256 checksum How to use checksums |
5dd6c1a77877a1206fc164dfded3aa7e0232a9580816da517946509ff14e1945
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 8, 2026.
Transparency log
