{"repo":"tanbro/mkdocs-nbconvert","free":true,"listed":false,"github":"https://github.com/tanbro/mkdocs-nbconvert","clone":"git clone https://github.com/tanbro/mkdocs-nbconvert.git","description":"A MkDocs plug-in provides a source parser for *.ipynb files","language":"Jupyter Notebook","stars":13,"topics":["mkdocs","mkdocs-plugin","jupyter-notebook","markdown","nbconvert","jupyter","notebook","notebook-publish"],"license":"BSD-2-Clause","category":"docs-static-sites","readme_excerpt":"mkdocs-nbconvert A [MkDocs][] plugin provides a source parser for .ipynb [Jupyter][] Notebook files, based on [nbconvert][]. Features - Converts Jupyter Notebook files ( .ipynb ) to Markdown during the MkDocs build process - Supports executing notebooks before conversion to include output results - Concurrent processing for faster builds with max workers option - Flexible configuration for input/output directories and execution options - Automatic cleanup of temporary files after build Installation This MkDocs plugin is based on Jupyter nbconvert. When install the plugin, jupyter and nbconvert will also be installed. Install by pip Install from source Quick Start Mkdocs configuration Add the nbconvert into configuration file ( mkdocs.yml )'s plugins list In nav section, add .ipynb files as normal markdown files with replacing extension .ipynb to .md , since they're converted to markdown files in output dir : Warning: converted notebooks/ .md files will be removed at the end of building. Configuration The plugin provides several configuration options: - input dir : Directory where to scan .ipynb files Either absolute or relative path. When relative, it's from mkdocs configuration file's directory. When omitted, default value is notebooks - output dir : Export notebook files to markdown files in the directory. It MUST be a relative path to doc dir When omitted, default value is notebooks . - recursive : Whether scan .ipynb files in subdirectories recursively When omitted, defau","default_branch":null,"files":null,"tree":[],"storefront":"/r/tanbro","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/tanbro/mkdocs-nbconvert/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."}