# `mkdocs` plugin for jupyter notebooks
i think i want more control of how `mkdocs` renders notebooks.
i've been using [`mkdocs-jupyter`][mkdocs-jupyter] for a while and it is great,
but i need more knobs.
my particular need is to configure `nbconvert` exporters with more fine grain control than what [`mkdocs-jupyter`][mkdocs-jupyter] offers.
the major difference is we are going to target markdown output rather than html.
[mkdocs-jupyter]: https://github.com/danielfrg/mkdocs-jupyter
[plugin]: https://www.mkdocs.org/dev-guide/plugins/
i think i want more control of how
mkdocs
renders notebooks.
i've been using
mkdocs-jupyter
for a while and it is great,
but i need more knobs.
my particular need is to configure
nbconvert
exporters with more fine grain control than what
mkdocs-jupyter
offers.
the major difference is we are going to target markdown output rather than html.
## checklist for successfully integrating the plugin
steps to adding a [`mkdocs` plugin][plugin] to this the `tonyfast` project:
- [x] add plugin to `mkdocs.yml` ```yamlplugins:-markdown_notebook ```- [x] define plugin entry point for `tonyfast` ```toml[project.entry-points."mkdocs.plugins"]markdown_notebook="tonyfast.mkdocs:MarkdownNotebook" ```- [x] build the `MarkdownNotebook` plugin
- [x] integrate the plugin
```pythonfromtonyfast.mkdocsimportMarkdownNotebook ```- [ ] add and improve the `nbconvert` export display renderers
[mkdocs-jupyter]: https://github.com/danielfrg/mkdocs-jupyter
[plugin]: https://www.mkdocs.org/dev-guide/plugins/
## building the [`mkdocs` plugin][plugin]
[mkdocs-jupyter]: https://github.com/danielfrg/mkdocs-jupyter
[plugin]: https://www.mkdocs.org/dev-guide/plugins/