Skip to main content

MkDocs plugin for embedding PDFs in a Markdown way

Project description

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=pdf/application }

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-pdf-0.1.0.tar.gz (2.8 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_pdf-0.1.0-py3-none-any.whl (3.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page