[](https://github.com/timvink/mkdocs-print-site-plugin/actions)
[](https://codecov.io/gh/timvink/mkdocs-print-site-plugin)
# mkdocs-print-site-plugin
[MkDocs](https://www.mkdocs.org/) 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](https://timvink.github.io/mkdocs-print-site-plugin/print_page.html).
## Features :star2:
- Support for [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme, including features like instant loading, dark color themes and certain plugins (f.e. the [tags](https://squidfunk.github.io/mkdocs-material/plugins/tags/) plugin)
- Support for [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) theme
- Support for pagination in PDFs.
- Many options to customize appearance
- Option to add a cover page
- Lightweight, no dependencies.
## Setup
Install the plugin using `pip3`:
```bash
pip3 install mkdocs-print-site-plugin
```
Next, add the following lines to your `mkdocs.yml`:
```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](https://timvink.github.io/mkdocs-print-site-plugin/how-to/export-HTML.html))
- Export to PDF using your browser using *File > Print > Save as PDF* (see [export to PDF](https://timvink.github.io/mkdocs-print-site-plugin/how-to/export-PDF.html))
## Documentation
Available at [timvink.github.io/mkdocs-print-site-plugin](https://timvink.github.io/mkdocs-print-site-plugin/).
## Contributing
Contributions are very welcome! Start by reading the [contribution guidelines](https://timvink.github.io/mkdocs-print-site-plugin/contributing.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-print-site-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "mkdocs, plugin, print, pdf",
"author": null,
"author_email": "Tim Vink <vinktim@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/93/4d/41bc1abd490fa82e4f3ec49a0ae99459ad9857750fcda05adb84b3665c41/mkdocs_print_site_plugin-2.6.0.tar.gz",
"platform": null,
"description": "[](https://github.com/timvink/mkdocs-print-site-plugin/actions)\n\n\n\n[](https://codecov.io/gh/timvink/mkdocs-print-site-plugin)\n\n\n\n# mkdocs-print-site-plugin\n\n[MkDocs](https://www.mkdocs.org/) 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](https://timvink.github.io/mkdocs-print-site-plugin/print_page.html).\n\n## Features :star2:\n\n- Support for [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme, including features like instant loading, dark color themes and certain plugins (f.e. the [tags](https://squidfunk.github.io/mkdocs-material/plugins/tags/) plugin)\n- Support for [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) theme\n- Support for pagination in PDFs.\n- Many options to customize appearance\n- Option to add a cover page\n- Lightweight, no dependencies.\n\n## Setup\n\nInstall the plugin using `pip3`:\n\n```bash\npip3 install mkdocs-print-site-plugin\n```\n\nNext, add the following lines to your `mkdocs.yml`:\n\n```yml\nplugins:\n - search\n - print-site\n```\n\n> \u26a0\ufe0f 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.\n\n> 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.\n\n## Usage\n\n- Navigate to `/print_page/` or `print_page.html`\n- Export to standalone HTML (see [export to HTML](https://timvink.github.io/mkdocs-print-site-plugin/how-to/export-HTML.html))\n- Export to PDF using your browser using *File > Print > Save as PDF* (see [export to PDF](https://timvink.github.io/mkdocs-print-site-plugin/how-to/export-PDF.html))\n\n## Documentation\n\nAvailable at [timvink.github.io/mkdocs-print-site-plugin](https://timvink.github.io/mkdocs-print-site-plugin/).\n\n## Contributing\n\nContributions are very welcome! Start by reading the [contribution guidelines](https://timvink.github.io/mkdocs-print-site-plugin/contributing.html).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs plugin that combines all pages into one, allowing for easy export to PDF and standalone HTML.",
"version": "2.6.0",
"project_urls": {
"Homepage": "https://github.com/timvink/mkdocs-print-site-plugin"
},
"split_keywords": [
"mkdocs",
" plugin",
" print",
" pdf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb7a2a863dfc892f45f309c1d662a24d88d32b6f1b6bf29158dd44278c2e7890",
"md5": "0e13f7d06836b2d1f73c5d5bdd1b4766",
"sha256": "f226686cafb549a6b6fa20b1f7acd50e8da98b16978a7df5df5457168cf2adda"
},
"downloads": -1,
"filename": "mkdocs_print_site_plugin-2.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e13f7d06836b2d1f73c5d5bdd1b4766",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 26479,
"upload_time": "2024-09-12T11:42:07",
"upload_time_iso_8601": "2024-09-12T11:42:07.017710Z",
"url": "https://files.pythonhosted.org/packages/bb/7a/2a863dfc892f45f309c1d662a24d88d32b6f1b6bf29158dd44278c2e7890/mkdocs_print_site_plugin-2.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "934d41bc1abd490fa82e4f3ec49a0ae99459ad9857750fcda05adb84b3665c41",
"md5": "714e687d1831bb5239bff347abf36159",
"sha256": "621e3eed4907b87c93f930a065c5c423ef11e0a2a058e78c6bd9a149df0ab918"
},
"downloads": -1,
"filename": "mkdocs_print_site_plugin-2.6.0.tar.gz",
"has_sig": false,
"md5_digest": "714e687d1831bb5239bff347abf36159",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 168941,
"upload_time": "2024-09-12T11:42:09",
"upload_time_iso_8601": "2024-09-12T11:42:09.054497Z",
"url": "https://files.pythonhosted.org/packages/93/4d/41bc1abd490fa82e4f3ec49a0ae99459ad9857750fcda05adb84b3665c41/mkdocs_print_site_plugin-2.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-12 11:42:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timvink",
"github_project": "mkdocs-print-site-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "mkdocs-material",
"specs": [
[
">=",
"7.3.0"
]
]
}
],
"lcname": "mkdocs-print-site-plugin"
}
JSON
