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.10.2.tar.gz (475.2 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: mkdocs-jupyter-0.10.2.tar.gz
  • Upload date:
  • Size: 475.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191201 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.8.0

File hashes

Hashes for mkdocs-jupyter-0.10.2.tar.gz
Algorithm Hash digest
SHA256 42ff7b0c64018a39822588ecedcb715a4bdbeda3700ef39d158a0ebe042879ac
MD5 61f14fece7305a61ddc2c7748a688145
BLAKE2b-256 8c127470e673d64465a729f82e6f6cfcefbefc9593b1d06d3fd1f9acd93dcdf6

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