# MkDocs Exporter
<div>
<a href="https://pypi.org/project/mkdocs-exporter">
<img src="https://img.shields.io/pypi/v/mkdocs-exporter?color=blue">
</a>
<a href="https://pypi.org/project/mkdocs-exporter">
<img src="https://img.shields.io/pypi/pyversions/mkdocs-exporter?color=blue">
</a>
<a href="https://pypi.org/project/mkdocs-exporter">
<img src="https://img.shields.io/pypi/dm/mkdocs-exporter?color=blue">
</a>
<a href="https://github.com/adrienbrignon/mkdocs-exporter/blob/master/LICENSE">
<img align="right" src="https://img.shields.io/github/license/adrienbrignon/mkdocs-exporter?color=white">
</a>
</div>
<a href="https://adrienbrignon.github.io/mkdocs-exporter/getting-started/">
<img src="https://github.com/adrienbrignon/mkdocs-exporter/assets/10183277/85c768f6-fe27-43a1-998c-ac89e926cba1" align="right" width="350">
</a>
<br />
A highly configurable plugin for [*MkDocs*](https://github.com/mkdocs/mkdocs) that exports your pages as PDF documents.
Additionally, it can combine your entire documentation into a single PDF file.
- [Documentation](https://adrienbrignon.github.io/mkdocs-exporter)
- [PyPI](https://pypi.org/project/mkdocs-exporter)
- [Examples](./examples)
## Features
- 🚀 **Fast** - All PDF documents are generated concurrently!
- 🎨 **Customizable** - full control over the resulting documents
- Combine all your pages into a single PDF document
- Create [cover pages](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-documents/#setting-up-cover-pages)
- Define custom scripts and stylesheets to customize your PDF documents
- Add [buttons](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-buttons/) to the top of your pages ([example](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-buttons/))
- Compatible with [`material`](https://github.com/squidfunk/mkdocs-material) and [`readthedocs`](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) themes
- Check out sample PDF documents [here](./examples/themes)
- ⭐ **Powerful** - it uses a headless browser and some awesome libraries under the hood to generate PDF documents
- [*Playwright*](https://github.com/microsoft/playwright-python) to automate browsers
- [*Paged.js*](https://github.com/pagedjs/pagedjs) polyfills included (provide [Paged Media](https://www.w3.org/TR/css-page-3/) and [Generated Content](https://www.w3.org/TR/css-gcpm-3/) CSS modules)
- [*Sass*](https://sass-lang.com/) support included for your stylesheets
## Prerequisites
- Python `>= 3.9`
- MkDocs `>= 1.4`
## Installation
The plugin is hosted on [*PyPI*](https://pypi.org/project/mkdocs-exporter/) and can be installed via `pip` (or your favourite package manager):
```bash
pip install mkdocs-exporter
```
## Usage
The following configuration excerpt from the [`mkdocs.yml`](./mkdocs.yml) configuration file used by this documentation should cover the basic functionalities of this plugin:
```yaml
plugins:
- exporter:
formats:
pdf:
enabled: !ENV [MKDOCS_EXPORTER_PDF, true]
concurrency: 8
stylesheets:
- resources/stylesheets/pdf.scss
covers:
front: resources/templates/covers/front.html.j2
back: resources/templates/covers/back.html.j2
aggregator:
enabled: true
output: .well-known/site.pdf
covers: all
```
Check out a [sample PDF generated by this plugin](examples/example.pdf), it includes custom CSS and features cover pages.
## Roadmap
- [x] Combine all pages into a single PDF document (✅ released in [`v6.0.0`](https://github.com/adrienbrignon/mkdocs-exporter/releases/tag/v6.0.0))
- [ ] Create a *GitHub* action that includes all dependencies to build the documentation and generate PDF documents
Feel free to request additional features by submitting an issue or contributing through a pull request.
## Contributing
We welcome contributions from the community to enhance MkDocs Exporter.
Whether you want to report a bug, suggest a feature, improve the documentation, or contribute code, your help is appreciated!
## License
This project is licensed under the `MIT License (MIT)`, which you can read [here](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/adrienbrignon/mkdocs-exporter",
"name": "mkdocs-exporter",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "mkdocs, pdf, exporter",
"author": "Adrien Brignon",
"author_email": "adrien@brignon.dev",
"download_url": "https://files.pythonhosted.org/packages/db/32/0e4495d7686da711ec301e071a9850d0426e41ee05f12ddfa81e2fb1c98c/mkdocs_exporter-6.2.0.tar.gz",
"platform": null,
"description": "# MkDocs Exporter\n\n<div>\n <a href=\"https://pypi.org/project/mkdocs-exporter\">\n <img src=\"https://img.shields.io/pypi/v/mkdocs-exporter?color=blue\">\n </a>\n <a href=\"https://pypi.org/project/mkdocs-exporter\">\n <img src=\"https://img.shields.io/pypi/pyversions/mkdocs-exporter?color=blue\">\n </a>\n <a href=\"https://pypi.org/project/mkdocs-exporter\">\n <img src=\"https://img.shields.io/pypi/dm/mkdocs-exporter?color=blue\">\n </a>\n <a href=\"https://github.com/adrienbrignon/mkdocs-exporter/blob/master/LICENSE\">\n <img align=\"right\" src=\"https://img.shields.io/github/license/adrienbrignon/mkdocs-exporter?color=white\">\n </a>\n</div>\n<a href=\"https://adrienbrignon.github.io/mkdocs-exporter/getting-started/\">\n <img src=\"https://github.com/adrienbrignon/mkdocs-exporter/assets/10183277/85c768f6-fe27-43a1-998c-ac89e926cba1\" align=\"right\" width=\"350\">\n</a>\n<br />\n\nA highly configurable plugin for [*MkDocs*](https://github.com/mkdocs/mkdocs) that exports your pages as PDF documents. \nAdditionally, it can combine your entire documentation into a single PDF file.\n\n- [Documentation](https://adrienbrignon.github.io/mkdocs-exporter)\n- [PyPI](https://pypi.org/project/mkdocs-exporter)\n- [Examples](./examples)\n\n## Features\n\n- \ud83d\ude80 **Fast** - All PDF documents are generated concurrently!\n- \ud83c\udfa8 **Customizable** - full control over the resulting documents\n - Combine all your pages into a single PDF document\n - Create [cover pages](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-documents/#setting-up-cover-pages)\n - Define custom scripts and stylesheets to customize your PDF documents\n - Add [buttons](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-buttons/) to the top of your pages ([example](https://adrienbrignon.github.io/mkdocs-exporter/setup/setting-up-buttons/))\n - Compatible with [`material`](https://github.com/squidfunk/mkdocs-material) and [`readthedocs`](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) themes\n - Check out sample PDF documents [here](./examples/themes)\n- \u2b50 **Powerful** - it uses a headless browser and some awesome libraries under the hood to generate PDF documents\n - [*Playwright*](https://github.com/microsoft/playwright-python) to automate browsers\n - [*Paged.js*](https://github.com/pagedjs/pagedjs) polyfills included (provide [Paged Media](https://www.w3.org/TR/css-page-3/) and [Generated Content](https://www.w3.org/TR/css-gcpm-3/) CSS modules)\n - [*Sass*](https://sass-lang.com/) support included for your stylesheets\n\n## Prerequisites\n\n- Python `>= 3.9`\n- MkDocs `>= 1.4`\n\n## Installation\n\nThe plugin is hosted on [*PyPI*](https://pypi.org/project/mkdocs-exporter/) and can be installed via `pip` (or your favourite package manager):\n\n```bash\npip install mkdocs-exporter\n```\n\n## Usage\n\nThe following configuration excerpt from the [`mkdocs.yml`](./mkdocs.yml) configuration file used by this documentation should cover the basic functionalities of this plugin:\n\n```yaml\nplugins:\n - exporter:\n formats:\n pdf:\n enabled: !ENV [MKDOCS_EXPORTER_PDF, true]\n concurrency: 8\n stylesheets:\n - resources/stylesheets/pdf.scss\n covers:\n front: resources/templates/covers/front.html.j2\n back: resources/templates/covers/back.html.j2\n aggregator:\n enabled: true\n output: .well-known/site.pdf\n covers: all\n```\n\nCheck out a [sample PDF generated by this plugin](examples/example.pdf), it includes custom CSS and features cover pages.\n\n## Roadmap\n\n- [x] Combine all pages into a single PDF document (\u2705 released in [`v6.0.0`](https://github.com/adrienbrignon/mkdocs-exporter/releases/tag/v6.0.0))\n- [ ] Create a *GitHub* action that includes all dependencies to build the documentation and generate PDF documents\n\nFeel free to request additional features by submitting an issue or contributing through a pull request.\n\n## Contributing\n\nWe welcome contributions from the community to enhance MkDocs Exporter. \nWhether you want to report a bug, suggest a feature, improve the documentation, or contribute code, your help is appreciated!\n\n## License\n\nThis project is licensed under the `MIT License (MIT)`, which you can read [here](LICENSE).\n",
"bugtrack_url": null,
"license": null,
"summary": "A highly-configurable plugin for MkDocs that exports your pages to PDF files.",
"version": "6.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/adrienbrignon/mkdocs-exporter/issues",
"Homepage": "https://github.com/adrienbrignon/mkdocs-exporter",
"Repository": "https://github.com/adrienbrignon/mkdocs-exporter"
},
"split_keywords": [
"mkdocs",
" pdf",
" exporter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6718a0122e815255ba2953a0425f8a961117f9ef614afb5090f3af42748c5e0",
"md5": "b6b2ceeac8e9c64b7402d5dac91bdaa5",
"sha256": "44e443c1fb9a6cffad2f8547bbdc9b0e79b15775b7c3ec943a9de6f6c1033f8e"
},
"downloads": -1,
"filename": "mkdocs_exporter-6.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b6b2ceeac8e9c64b7402d5dac91bdaa5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 120426,
"upload_time": "2024-10-29T08:25:08",
"upload_time_iso_8601": "2024-10-29T08:25:08.671140Z",
"url": "https://files.pythonhosted.org/packages/d6/71/8a0122e815255ba2953a0425f8a961117f9ef614afb5090f3af42748c5e0/mkdocs_exporter-6.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db320e4495d7686da711ec301e071a9850d0426e41ee05f12ddfa81e2fb1c98c",
"md5": "60c8715388750b92953a2d06c081a7de",
"sha256": "75fbd757c8fe8302489a48193c37d632dec2d0112d67fe2f72d1c7d80c6fbbfc"
},
"downloads": -1,
"filename": "mkdocs_exporter-6.2.0.tar.gz",
"has_sig": false,
"md5_digest": "60c8715388750b92953a2d06c081a7de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 113327,
"upload_time": "2024-10-29T08:25:10",
"upload_time_iso_8601": "2024-10-29T08:25:10.290566Z",
"url": "https://files.pythonhosted.org/packages/db/32/0e4495d7686da711ec301e071a9850d0426e41ee05f12ddfa81e2fb1c98c/mkdocs_exporter-6.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 08:25:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adrienbrignon",
"github_project": "mkdocs-exporter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mkdocs-exporter"
}
JSON
