An MkDocs plugin that allows users to add additional content to the ToC sidebar using the Material theme.
Currently this plugin will only work with the Table of Contents sidebars in the Material theme for MkDocs.
Install the plugin using pip:
pip install mkdocs-toc-sidebar-plugin
Activate the plugin in
plugins: - search - toc-sidebar
Note: If you have no
pluginsentry in your config file yet, you'll likely also want to add the
searchplugin. MkDocs enables it by default if there is no
pluginsentry set, but now you have to enable it explicitly.
More information about plugins in the MkDocs documentation.
To add a toc sidebar to one of your markdown pages, simply add a div anywhere in the markdown source like so:
<div markdown=1 class="sidebar"> # Toc Sidebar It's filled with information specific to this page. It's locked to the screen just like the ToC! </div>
More information about templates here.
More information about blocks here.