mkdocs-toggle-sidebar-plugin 0.0.1

TODO

mkdocs-crosslink-plugin

This package allows you to add links to other MkDocs sites (or sites created with similar page generator).

Usage

Setup

First install the PyPI package:

pip install mkdocs-toggle-sidebar-plugin

Add something like the following to your mkdocs.yml:

plugins:
- search
- toggle-sidebar

Key bindings

The plugin adds the following key bindings:

Key	Action
++b++	toggle both (TOC and navigation)
++m++	toggle navigation menu
++t++	toggle TOC

Theme support

Theme	Theme version	Plugin version	Status
mkdocs-material	9.1.21	0.0.1	works
mkdocs (default)	1.5.2	0.0.1	not yet implemented

Just open a issue / PR if you use a strange theme or the info above is not up to date anymore.

Notable changes

Version 0.0.1

Prototype with mkdocs-material implementation.