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=application/pdf }
Optionally, you can specify style constraints, e.g.
![Alt text](<path to pdf>){ type=application/pdf style="min-height:25vh;width:100%" }
Project details
Release history Release notifications | RSS feed
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.1.tar.gz
(2.8 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_pdf-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c558eed996f44e660da7a14fad2b55b53fff8152fa1ee5db892e18a3f78783c6 |
|
MD5 | a743821a05e15a75f8ad65cc27bd5fd7 |
|
BLAKE2b-256 | ddf7d588fe0b28963efdc13071a7a2349473059ff6a874c481061cc7278c4b1c |