Skip to main content

MkDocs Jupyter

Project description

mkdocs-jupyter: Use Jupyter Notebooks in mkdocs

mkdocs-jupyter

  • 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

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

Uploaded Source

File details

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

File metadata

  • Download URL: mkdocs-jupyter-0.10.0.tar.gz
  • Upload date:
  • Size: 475.6 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.40.2 CPython/3.8.0

File hashes

Hashes for mkdocs-jupyter-0.10.0.tar.gz
Algorithm Hash digest
SHA256 3905dffa421380dd2dfb24ab01e9f34086e051a5348b4e609d840472caa980e5
MD5 85f7ba4bbfeb2f248ab66920cb0e86bc
BLAKE2b-256 3051bb6304ffbfdb4268d2ef5a5112dd2025d86af56380666247af6538e900a4

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