Getting started

Introduction

MkDocs Exporter is a plugin for MkDocs, it allows you to export your documentation to various formats such as PDF. If you're familiar with Python, you can install the plugin with pip (or your favourite package manager).

Did you know?

This documentation features the plugin: you can download this page as a PDF document and read it offline!

Try this out by clicking the download button at the top of this page (or you can directly head here).

Prerequisites

Python >= 3.8
MkDocs >= 1.4
A compatible theme
- material ( used by this documentation)
- readthedocs

Installation

You can start by installing the plugin with the package manager of your choice:

pip install mkdocs-exporter

You can now register the plugin in your configuration file:

plugins:
  - exporter

Check out the setup guides for more details about how to use and configure the plugin.