Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timvink/mkdocs-print-site-plugin
MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML.
https://github.com/timvink/mkdocs-print-site-plugin
mkdocs mkdocs-plugin pdf pdfs print
Last synced: 5 days ago
JSON representation
MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML.
- Host: GitHub
- URL: https://github.com/timvink/mkdocs-print-site-plugin
- Owner: timvink
- License: mit
- Created: 2020-08-15T12:02:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T11:40:50.000Z (5 months ago)
- Last Synced: 2025-02-08T20:05:17.370Z (12 days ago)
- Topics: mkdocs, mkdocs-plugin, pdf, pdfs, print
- Language: Python
- Homepage: https://timvink.github.io/mkdocs-print-site-plugin/
- Size: 1.82 MB
- Stars: 152
- Watchers: 5
- Forks: 24
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- best-of-python-dev - GitHub - 15% open · ⏱️ 23.05.2024): (Documentation)
- jimsghstars - timvink/mkdocs-print-site-plugin - MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML. (Python)
README
[](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).