{"repo":"danielfrg/mkdocs-jupyter","free":true,"listed":false,"github":"https://github.com/danielfrg/mkdocs-jupyter","clone":"git clone https://github.com/danielfrg/mkdocs-jupyter.git","description":"Use Jupyter Notebook in mkdocs","language":"Jupyter Notebook","stars":505,"topics":["mkdocs","jupyter","jupyter-notebook","documentation","blogging"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"mkdocs-jupyter: Use Jupyter Notebooks in mkdocs - Docs demo Site - Add Jupyter Notebooks directly to the mkdocs navigation - Support for multiple formats: - .ipynb and .py files (using jupytext) - Same style as regular Jupyter Notebooks - Support Jupyter Themes - Option to execute the notebook before converting - Support for ipywidgets - Support for mkdocs TOC - Option to include notebook source Installation Configuration In the mkdocs.yml use Jupyter notebooks ( .ipynb ) or Python scripts ( .py ) as pages: Titles and Table of Contents The first h1 header ( # ) in your notebook will be used as the title. This can be turned off in the configuration (in which case the filename will be used as title): In order to see the table of contents you need to maintain a hierarchical headers structure in your notebooks. You must use h2 headers ( ## ) and not h1 ( # ) If you want to nest headers in the TOC you need to add additional levels later in the same markdown cell or new bottom markdown cells: Including or Ignoring Files You can control which files are included or ignored via lists of glob patterns: Execute Notebook You can tell the plugin to execute the notebook before converting, default is False : You can tell the plugin to ignore the execution of some files (with glob matching): To fail when notebook execution fails set allow errors to false : Kernel By default the plugin will use the kernel specified in the notebook to execute it. You can specify a custom kernel name to use for","default_branch":null,"files":null,"tree":[],"storefront":"/r/danielfrg","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/danielfrg/mkdocs-jupyter/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}