Skip to main content

MkDocs Jupyter

Project description

mkdocs-jupyter: Use Jupyter Notebooks in mkdocs

PyPI version

  • Add Jupyter Notebooks directly to the mkdocs navigation
  • Feel and look the regular Jupyter Notebook style inside mkdocs pages
  • Option to execute the notebook before converting
  • Show ipywidgets (requires execution of the notebook)
  • Support for mkdocs TOC

mkdocs-jupyter

Usage

pip install mkdocs-jupyter

In your mkdocs.yml:

nav:
- Notebook: notebook.ipynb

plugins:
  - mkdocs-jupyter

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-jupyter-0.11.0.tar.gz (475.9 kB view details)

Uploaded Source

File details

Details for the file mkdocs-jupyter-0.11.0.tar.gz.

File metadata

  • Download URL: mkdocs-jupyter-0.11.0.tar.gz
  • Upload date:
  • Size: 475.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for mkdocs-jupyter-0.11.0.tar.gz
Algorithm Hash digest
SHA256 42a922b594c52ed396f4f82077e9f414f6af28920e812208240f6d903e7395fe
MD5 66f10cfe664d5cbf64d80f30df4e457e
BLAKE2b-256 b2171b14a07924bc7b4a68acecfbf5509649b7210a3f489bb5ffad44d0ce2047

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page