Mkdocs Jupyter
Use Jupyter Notebook in mkdocs
Overview:
The mkdocs-jupyter theme allows users to integrate Jupyter Notebooks directly into mkdocs websites. It supports multiple formats like .ipynb and .py files and offers features such as executing notebooks before conversion, support for ipywidgets, Jupyter themes, and more.
Features:
- Direct Integration: Add Jupyter Notebooks directly to the mkdocs navigation.
- Format Support: Supports .ipynb and .py files using jupytext.
- Style Consistency: Maintains the same style as regular Jupyter Notebooks.
- Jupyter Themes: Supports different Jupyter themes.
- Execution Option: Option to execute the notebook before conversion.
- ipywidgets Support: Supports ipywidgets within the notebooks.
- Table of Contents: Supports mkdocs Table of Contents.
- File Control: Control which files are included or ignored via lists of glob patterns.
Summary:
mkdocs-jupyter is a versatile theme that seamlessly integrates Jupyter Notebooks into mkdocs websites. With support for various features like different formats, Jupyter themes, execution options, and more, it enhances the functionality and aesthetics of the mkdocs platform. Its flexible customization options make it a valuable addition for users looking to enhance their documentation with interactive notebook content.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.