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.

Files for mkdocs-jupyter, version 0.10.2
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs-jupyter-0.10.2.tar.gz (475.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page