/mkdocs-pdf

This plugin allows you to embed PDFs in your documentation using standard Markdown syntax.

Primary LanguagePythonMIT LicenseMIT

MkDocs PDF

This plugin allows you to embed PDFs in your documentation using standard Markdown syntax.

Installation

Install the package with pip

pip install mkdocs-pdf

Configuration

# mkdocs.yml
markdown_extensions:
  - attr_list
plugins:
  - mkdocs-pdf

Usage

To embed a PDF file simple use the following syntax.

![Alt text](<path to pdf>){ type=application/pdf }

Optionally, you can specify style constraints, e.g.

![Alt text](<path to pdf>){ type=application/pdf style="min-height:25vh;width:100%" }