Skip to main content

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%" }

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.2.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_pdf-0.1.2-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_pdf-0.1.2.tar.gz.

File metadata

  • Download URL: mkdocs_pdf-0.1.2.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for mkdocs_pdf-0.1.2.tar.gz
Algorithm Hash digest
SHA256 22bf70d514cf430db1620d0887b6679a7b1e45e683f6a9e76e42941b34d74c99
MD5 1c5164895bf86fd62d21d5c7b9f0bcc3
BLAKE2b-256 31c45f57c1aacfe19aacf941c69d1f9f734b2f5b499c73f6f758af0d94529f5c

See more details on using hashes here.

File details

Details for the file mkdocs_pdf-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_pdf-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for mkdocs_pdf-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c78bb194400c8753d84570fbe04252e6f9ac1b357a8565f2964f7e8f5689af33
MD5 dbc7a8890a06b47a759f57467f4294d2
BLAKE2b-256 82100ad69ac0fc053f62c154a5d48442ec082bb6e41b0f43d0887348ef278217

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page