danielfrg / mkdocs-jupyter

Use Jupyter Notebook in mkdocs
https://mkdocs-jupyter.danielfrg.com
Apache License 2.0
402 stars 49 forks source link

Allow specification of markdown TOC depth #188

Closed angus-g closed 9 months ago

angus-g commented 9 months ago

This adds the config option "toc_depth", defaulting to the Python Markdown's default of 6, which controls the TOC depth of the rendered notebook only.

This is in lieu of being able to provide a per-page customisation through metadata, which in some ways is probably the desired solution. But I don't think I have my head around the architecture of the MkDocs system to be able to do it that way. Update: I've just noticed the Meta plugin which does do that, but it's only available for Insiders at the moment!

danielfrg commented 9 months ago

I think this should be good enough for most cases. We can reevaluate how to do it per page later.

github-actions[bot] commented 9 months ago

Preview deployment

Name Link
Deploy Preview Url https://78083c07.mkdocs-jupyter-danielfrg-com.pages.dev
Latest deploy log https://github.com/danielfrg/mkdocs-jupyter/actions/runs/7896017890
Latest commit 93bb183544dc024b4de2a0c9341328ae7317e3db
Environment production