mkdocs-with-pdf
Generate a single PDF file from MkDocs repository
Decision gist · record as of 2026-08-14
Yes, with conditions. Install it if you need PDF export from MkDocs and are willing to accept dormant maintenance. The package is stable and has no known vulnerabilities, but you should verify compatibility with your specific MkDocs and Python versions before relying on it in production. Be prepared to manage weasyprint's system-level dependencies (cairo, Pango, GDK-PixBuf) on your build platform.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- WeasyPrint requires cairo, Pango, and GDK-PixBuf system libraries installed separately for your platform (Linux, macOS, or Windows).
- Python 3.6 or higher and MkDocs 1.0+ are required.
- Low install friction with a wheel distribution.
License · maintenance · safety
MIT (permissive) — MIT license is permissive, allowing commercial and private use with minimal restrictions. You must retain the license notice in distributions.
last release 2021-07-03 (1868 days) · last repo commit 2024-05-25 · 393 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 342,684 downloads/mo, #7,395 on PyPI
Alternatives
Verify before relying
pip install mkdocs-with-pdf
# In mkdocs.yml:
plugins:
- with-pdf
# Then run:
mkdocs build- Whether the package works reliably with current MkDocs versions (last release 2021-07-03, no recent maintenance signal)
- Compatibility with modern Python versions beyond 3.9 (classifiers only list up to 3.9)
- Performance impact on large documentation sites during PDF generation
What it is and what it does
mkdocs-with-pdf is a plugin for MkDocs that converts your entire documentation site into a single PDF file during the build process. It uses weasyprint as its rendering engine and automatically generates a cover page, table of contents, and heading numbers (h1–h3) in the output. The plugin integrates directly into MkDocs' build pipeline—you enable it in your mkdocs.yml configuration and it runs when you execute mkdocs build.
The package is designed for documentation teams who need to distribute their docs as a single PDF artifact. It offers customization options for cover pages, table of contents depth, heading numbering levels, and page exclusions. However, the project is dormant—the last release was in July 2021 and there have been no commits since May 2024. This means it may not be actively maintained for compatibility with newer MkDocs or Python versions.
Use it for
- Export a complete MkDocs documentation site as a single PDF for offline distribution or archival.
- Generate PDF documentation automatically as part of a CI/CD pipeline for release artifacts.
- Create printable versions of technical documentation with automatic table of contents and cover pages.
- Customize PDF output with cover logos, author metadata, and multi-column layouts for specific branding needs.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, with conditions.
Install it if you need PDF export from MkDocs and are willing to accept dormant maintenance. The package is stable and has no known vulnerabilities, but you should verify compatibility with your specific MkDocs and Python versions before relying on it in production. Be prepared to manage weasyprint's system-level dependencies (cairo, Pango, GDK-PixBuf) on your build platform.
Install
mkdocs-with-pdf on PyPI
Before you install
Low install friction with a wheel distribution. Maintenance is dormant—last release was 2021-07-03 and no commits since 2024-05-25. The package depends on weasyprint, which requires system libraries (cairo, Pango, GDK-PixBuf) to be installed separately on your platform.
WeasyPrint requires cairo, Pango, and GDK-PixBuf system libraries installed separately for your platform (Linux, macOS, or Windows). Python 3.6 or higher and MkDocs 1.0+ are required.
License in practice
MIT license is permissive, allowing commercial and private use with minimal restrictions. You must retain the license notice in distributions.
Quickstart
pip install mkdocs-with-pdf
# In mkdocs.yml:
plugins:
- with-pdf
# Then run:
mkdocs buildVerify before relying
- Whether the package works reliably with current MkDocs versions (last release 2021-07-03, no recent maintenance signal)
- Compatibility with modern Python versions beyond 3.9 (classifiers only list up to 3.9)
- Performance impact on large documentation sites during PDF generation
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.6 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesmkdocsweasyprintbeautifulsoup4libsass |
| Maintenance | Dormant 1,868 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 342,684 / month, #7,395 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaIntended Audience :: DevelopersIntended Audience :: Information TechnologyLicense :: OSI Approved :: MIT LicenseProgramming Language :: PythonProgramming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.6Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9 |
Evidence: mkdocs_with_pdf-0.9.3-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “generate pdf from documentation”
- mkdocs-with-pdfGenerates a single PDF file from an MkDocs documentation site, with…
- sphinx-simplepdfSphinx-SimplePDF is a Sphinx extension that converts Sphinx…
- md2pdfConverts Markdown files to PDF with custom CSS styling, Jinja…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also mkdocs-print-site-plugin · mkdocs-video · mkdocs-open-in-new-tab · mkdocstrings · mkdocs-autorefs · mkdocs-monorepo-plugin · django-weasyprint · mkdocs-click · mkdocs-multirepo-plugin · mkdocs-git-revision-date-plugin