MkDocs PDF with JS Plugin
A MkDocs plugin that exports your documentation as PDF with rendered JavaScript content. This is very useful if you want to have your mermaid diagrams in your pdf documents as well. A download link will be added to the top of your documentation.
Requirements
For executing the JavaScript code ChromeDriver is used. So it is nesseccary to
- install Chrome or Chromium
- download ChromeDriver and
- add the ChromeDriver to your PATH
Installation
Install the package with pip:
pip install mkdocs-pdf-with-js-plugin
Enable the plugin in your mkdocs.yml as folowing
plugins:
- search
- pdf-with-js
or with options
plugins:
- search
- pdf-with-js:
enable: true
Note: If you enable this plugin and you don't have plugins entry in your MkDocs config file yet, you will need to explicitly enable the search plugin. This plugin is enable by default when no plugins entry is set.
You can find further information about plugins in the MkDocs documentation
Config
enable- Enable or disable the PDF export.default: true
Usage
While building mkdocs build or serving mkdocs serve the documentation the pdfs get generated. They are stored in site_dir/pdfs.
Metadata
Release files for mkdocs-pdf-with-js-plugin 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-pdf-with-js-plugin-0.1.3.tar.gz | 5.3 kB | Without provenance | Details for mkdocs-pdf-with-js-plugin-0.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_pdf_with_js_plugin-0.1.3-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_pdf_with_js_plugin-0.1.3-py3-none-any.whl |
Total release size: 11.3 kB
Release files / mkdocs-pdf-with-js-plugin-0.1.3.tar.gz
| Download URL | mkdocs-pdf-with-js-plugin-0.1.3.tar.gz |
|---|---|
| Size | 5.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1dc39c6548e2aaf120a6c81494c000b0a7e419e8676d57985e35aa6aebadebcc
|
|
BLAKE2b-256 checksum How to use checksums |
77c8c161405a7b81f51bc173b5053685b09647461809f27f722b2bdd773dde77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
|
Release files / mkdocs_pdf_with_js_plugin-0.1.3-py3-none-any.whl
| Download URL | mkdocs_pdf_with_js_plugin-0.1.3-py3-none-any.whl |
|---|---|
| Size | 6.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
12814fcdebb24bb686e81f01a184eebbc07ca7ea143b21b9ad9d5cfa2822e700
|
|
BLAKE2b-256 checksum How to use checksums |
12ce5ddb7f8e649295a2cc60264c52bb9dae368a8b582d08e6083831e3e52b30
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6
|
Security for mkdocs-pdf-with-js-plugin 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.