[](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 and dark color themes.
- 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": "https://github.com/timvink/mkdocs-print-site-plugin",
"name": "mkdocs-print-site-plugin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "mkdocs plugin print pdf",
"author": "Tim Vink",
"author_email": "vinktim@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ee/0f/c6a2aac719063029d683fbc3ceee2580407314a072a4731c8d7b399fc239/mkdocs-print-site-plugin-2.4.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 and dark color themes.\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.4.0",
"project_urls": {
"Homepage": "https://github.com/timvink/mkdocs-print-site-plugin"
},
"split_keywords": [
"mkdocs",
"plugin",
"print",
"pdf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9bb614c10c71eca4e215cf570e2bc8ffb8eb35114a1af8b613eb7d7a00c73478",
"md5": "6806efa725912e22997765638293cf14",
"sha256": "2257e8116cdea6c4063a2bbd84c8cf00ace62de4cb2e09516124a08c20fc2033"
},
"downloads": -1,
"filename": "mkdocs_print_site_plugin-2.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6806efa725912e22997765638293cf14",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 30530,
"upload_time": "2024-04-10T11:24:03",
"upload_time_iso_8601": "2024-04-10T11:24:03.407748Z",
"url": "https://files.pythonhosted.org/packages/9b/b6/14c10c71eca4e215cf570e2bc8ffb8eb35114a1af8b613eb7d7a00c73478/mkdocs_print_site_plugin-2.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee0fc6a2aac719063029d683fbc3ceee2580407314a072a4731c8d7b399fc239",
"md5": "ef8b698c90de164221e37cd1526f17dc",
"sha256": "b44d4533c5be8bd4676d61ff9b8a946dc340ef5e745a8c60fe1072e22032b2d8"
},
"downloads": -1,
"filename": "mkdocs-print-site-plugin-2.4.0.tar.gz",
"has_sig": false,
"md5_digest": "ef8b698c90de164221e37cd1526f17dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24384,
"upload_time": "2024-04-10T11:24:04",
"upload_time_iso_8601": "2024-04-10T11:24:04.990988Z",
"url": "https://files.pythonhosted.org/packages/ee/0f/c6a2aac719063029d683fbc3ceee2580407314a072a4731c8d7b399fc239/mkdocs-print-site-plugin-2.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 11:24:04",
"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,
"lcname": "mkdocs-print-site-plugin"
}
JSON
