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
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.0.tar.gz
(2.8 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_pdf-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b45cd1fe90df5052294690eaf0d0a09102be9b9b7968d0d3bd66ce1d458c787 |
|
MD5 | 4845a3db5a9d7a2b6c383f6a18641b91 |
|
BLAKE2b-256 | cef01c37d42c75d44740dcb44d3571033c564073ae8f2e2cb6863e5d93688d1f |