Introducing nbdev-mkdocs

Hi everyone!

We have used nbdev for a few years now and are really excited about the v2. We use it in a slightly different way to generate documentation using Material for mkdocs from markdown files generated by nbdev/quarto combination. We wrapped the procedure into a new utility with the creative name nbdev-mkdocs. Version v0.0.1 is just released on PyPi, please give it a try and let us know how you feel about it. It could be an alternative for more general-purpose Python projects that need Material for Mkdocs styled documentation.

You can install it with:

pip install nbdev-mkdocs

Detailed instructions on how to use it, together with a preview of what you can expect from the tool can be found here.

Cheers,
Davor

4 Likes