mkdocs-pdf-export-plugin

The exported PDF supports the CSS paged media module. You can adjust margins, fonts, headers, and footers by adding a custom stylesheet to your MkDocs project.

To apply these styles, use the extra_css directive in your mkdocs.yml.

Example CSS for @page customization:

@page {
    size: a4 portrait;
    margin: 25mm 10mm 25mm 10mm;
    counter-increment: page;
    font-family: "Roboto","Helvetica Neue",Helvetica,Arial,sans-serif;
    @top-left {
        content: '© 2018 My Company';
    }
    @top-center {
        content: string(chapter);
    }
    @top-right {
        content: 'Page ' counter(page);
    }
}

To use the plugin, install it via pip and then register it in your mkdocs.yml configuration file.

Requirements:

• MkDocs >= 1.0
• Python >= 3.4
• WeasyPrint >= 44

Note on the search plugin: If you define a plugins section in your mkdocs.yml, MkDocs will no longer enable the default search plugin automatically. You should explicitly include search in your list if you want to keep search functionality enabled.

pip install mkdocs-pdf-export-plugin

plugins:
    - search
    - pdf-export

If you are using a theme that is not explicitly supported, you can implement a custom theme handler. This allows you to fix WeasyPrint rendering issues and control how the PDF download link is integrated into your site.

1. Create a Python module (e.g., theme-handler.py) in your project root.
2. Implement the following two methods:
   • get_stylesheet(): Returns a CSS string that is applied to fix specific rendering issues for WeasyPrint.
   • modify_html(): Logic to add a link to the PDF download within your theme's HTML.
3. Register the handler in mkdocs.yml using the theme_handler_path option.

Example Project Structure:

project-root
├── theme-handler.py
├── docs
├── mkdocs.yml
└── site

plugins:
    - pdf-export:
        theme_handler_path: theme-handler.py

You can configure the plugin by passing options under the pdf-export key within the plugins section of your mkdocs.yml file.

plugins:
    - pdf-export:
        verbose: true
        media_type: print
        enabled_if_env: ENABLE_PDF_EXPORT

You can provide a custom theme handler module by specifying its path relative to your project root using theme_handler_path.

plugins:
    - pdf-export:
        theme_handler_path: theme-handler.py