{"id":15017492,"url":"https://github.com/adrienbrignon/mkdocs-exporter","last_synced_at":"2025-10-24T11:34:44.287Z","repository":{"id":162905568,"uuid":"636864116","full_name":"adrienbrignon/mkdocs-exporter","owner":"adrienbrignon","description":"⚡ The fastest and most configurable plugin for MkDocs, allowing seamless export of individual pages and/or entire documentation as PDF documents.","archived":false,"fork":false,"pushed_at":"2024-10-29T08:28:27.000Z","size":1165,"stargazers_count":98,"open_issues_count":34,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-04T04:02:47.449Z","etag":null,"topics":["documentation","markdown","mkdocs","mkdocs-plugin","mkdocs-plugins","mkdocs-print","pdf","pdf-generation"],"latest_commit_sha":null,"homepage":"https://adrienbrignon.github.io/mkdocs-exporter/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adrienbrignon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"adrienbrignon"}},"created_at":"2023-05-05T20:39:10.000Z","updated_at":"2025-03-26T17:37:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"d4fd1485-812f-4bb7-bcb8-423dc3110ae1","html_url":"https://github.com/adrienbrignon/mkdocs-exporter","commit_stats":{"total_commits":122,"total_committers":4,"mean_commits":30.5,"dds":"0.040983606557377095","last_synced_commit":"de1099e6e1b9917e44a4328b4278466d19e134ad"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrienbrignon%2Fmkdocs-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrienbrignon%2Fmkdocs-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrienbrignon%2Fmkdocs-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrienbrignon%2Fmkdocs-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adrienbrignon","download_url":"https://codeload.github.com/adrienbrignon/mkdocs-exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647257,"owners_count":21139081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","markdown","mkdocs","mkdocs-plugin","mkdocs-plugins","mkdocs-print","pdf","pdf-generation"],"created_at":"2024-09-24T19:50:33.738Z","updated_at":"2025-10-24T11:34:39.250Z","avatar_url":"https://github.com/adrienbrignon.png","language":"Python","readme":"# MkDocs Exporter\n\n\u003cdiv\u003e\n  \u003ca href=\"https://pypi.org/project/mkdocs-exporter\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/mkdocs-exporter?color=blue\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.org/project/mkdocs-exporter\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/pyversions/mkdocs-exporter?color=blue\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.org/project/mkdocs-exporter\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/dm/mkdocs-exporter?color=blue\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/adrienbrignon/mkdocs-exporter/blob/master/LICENSE\"\u003e\n    \u003cimg align=\"right\" src=\"https://img.shields.io/github/license/adrienbrignon/mkdocs-exporter?color=white\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003ca href=\"https://adrienbrignon.github.io/mkdocs-exporter/getting-started/\"\u003e\n  \u003cimg src=\"https://github.com/adrienbrignon/mkdocs-exporter/assets/10183277/85c768f6-fe27-43a1-998c-ac89e926cba1\" align=\"right\" width=\"350\"\u003e\n\u003c/a\u003e\n\u003cbr /\u003e\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- 🚀 **Fast** - All PDF documents are generated concurrently!\n- 🎨 **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- ⭐ **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 `\u003e= 3.9`\n- MkDocs `\u003e= 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 (✅ 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","funding_links":["https://github.com/sponsors/adrienbrignon"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrienbrignon%2Fmkdocs-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadrienbrignon%2Fmkdocs-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrienbrignon%2Fmkdocs-exporter/lists"}