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).

Examples

• Read this documentation in the PDF format
• View this page in the PDF format

Prerequisites

• Python >= 3.9
• 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 configuration guides for more details about how to use and configure the plugin.