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

Metadata

Release files for mkdocs-pdf 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-pdf 0.1.2
File Size Uploaded
mkdocs_pdf-0.1.2.tar.gz 2.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-pdf 0.1.2
File Interpreter ABI Platform
mkdocs_pdf-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 6.2 kB

Release files / mkdocs_pdf-0.1.2.tar.gz

Download URL mkdocs_pdf-0.1.2.tar.gz
Size 2.9 kB
Tags Source
SHA-256 checksum
How to use checksums
22bf70d514cf430db1620d0887b6679a7b1e45e683f6a9e76e42941b34d74c99
BLAKE2b-256 checksum
How to use checksums
31c45f57c1aacfe19aacf941c69d1f9f734b2f5b499c73f6f758af0d94529f5c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Release files / mkdocs_pdf-0.1.2-py3-none-any.whl

Download URL mkdocs_pdf-0.1.2-py3-none-any.whl
Size 3.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c78bb194400c8753d84570fbe04252e6f9ac1b357a8565f2964f7e8f5689af33
BLAKE2b-256 checksum
How to use checksums
82100ad69ac0fc053f62c154a5d48442ec082bb6e41b0f43d0887348ef278217
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.18

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page