mkdocs-ipynb
Lighweight MkDocs plugin for loading Jupyter notebooks.
Interoperates with all other MkDocs features: admonitions, reference links, etc.
Installation
pip install mkdocs_ipynb
Requires MkDocs 1.6.1+
Usage
In mkdocs.yml:
...
plugins:
- ipynb
nav:
- some_notebook.ipynb
Under-the-hood it will be converted into markdown and then passed to MkDocs.
Other similar libaries
mkdocs-jupyterconverts Jupyter notebooks directly into HTML usingnbconvert. It doesn't support admonitions, reference links (e.g. to mkdocstrings references), etc.mknotebooksalso usesnbconvert. It has since fallen out of date with modern MkDocs.
Due to these limitations I wrote my own tiny plugin.
Further work?
Jupyter cells can output many kinds of MIME types (text/plain, image/png, ...). It's fairly trivial to add support for them; right now we support just text/plain and image/png because those are my use-cases. Happy to take PRs extending this if you have use-cases for others.
This plugin doesn't use nbconvert, mainly because that in turn depends on many other libraries, and I object to that kind of dependency sprawl.
Metadata
Release files for mkdocs-ipynb 0.1.1
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_ipynb-0.1.1.tar.gz | 8.2 kB | Without provenance | Details for mkdocs_ipynb-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_ipynb-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_ipynb-0.1.1-py3-none-any.whl |
Total release size: 20.1 kB
Release files / mkdocs_ipynb-0.1.1.tar.gz
| Download URL | mkdocs_ipynb-0.1.1.tar.gz |
|---|---|
| Size | 8.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0bc8791e98e0aec305d7e640b51f17794ddf20ead72f93f894e1951ec5524a16
|
|
BLAKE2b-256 checksum How to use checksums |
68b6091efeb0a58031e31e72fbedfedf7832e466e1275e191e875f05abfad68a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Release files / mkdocs_ipynb-0.1.1-py3-none-any.whl
| Download URL | mkdocs_ipynb-0.1.1-py3-none-any.whl |
|---|---|
| Size | 12.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dae68bd4e9b6581a1d1a102c447c921cd0c43b23712137ca80a31e0f9f70e4c1
|
|
BLAKE2b-256 checksum How to use checksums |
6c0176473cd0e3d06a30865a1aece673d9854381cc26e139cd38100ccca3e18f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Security for mkdocs-ipynb 0.1.1
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.