{"library":"mkdocs-jupyter","title":"MkDocs-Jupyter Plugin","description":"mkdocs-jupyter is an MkDocs plugin that enables the seamless integration of Jupyter notebooks (.ipynb files) and Jupytext-generated Python scripts (.nb.py files) directly into your MkDocs documentation. It allows for rendering notebooks, optionally executing them during the build process, supports theme integration, and offers granular control over the visibility of notebook cells and outputs using tags. The current stable version is 0.26.2, with active development and regular updates.","language":"python","status":"active","last_verified":"Tue Apr 14","install":{"commands":["pip install mkdocs-jupyter","pip install jupyter nbconvert ipykernel"],"cli":null},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"site_name: My Docs\n\nnav:\n  - Home: index.md\n  - My Notebook: notebooks/example.ipynb\n  - My Python Script: notebooks/script.py\n\nplugins:\n  - search\n  - mkdocs-jupyter:\n      execute: true  # Optional: Execute notebooks during build\n      include_source: true # Optional: Add download link for source notebooks\n      kernel_name: python3 # Optional: Specify kernel to use for execution\n","lang":"yaml","description":"To use mkdocs-jupyter, you primarily configure it in your `mkdocs.yml` file under the `plugins` section. After installation, create a `docs` directory with your markdown (`.md`), Jupyter notebooks (`.ipynb`), or Jupytext Python scripts (`.py`). Reference these files in your `nav` configuration. Ensure you have a basic `index.md` for your homepage.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}