Windmill theme for MkDocs

Outstanding mkdocs theme with a focus on navigation and usability, from Grist Labs.

Highlights:

• Convenient navigation for larger documentation projects.
• Retains state of the navigation menu across page transitions.
• Search with term highlighting.
• User may search in a quick dropdown or load results in a full page.
• Default mkdocs theme within pages, including syntax highlighting.

Quick start

To install using pip:

pip install mkdocs-windmill

To use in mkdocs.yml:

theme: windmill

Demo and documentation

More details are on this site generated with the Windmill theme:

• Usage for more on installation and usage.
• Customization for extra configuration options that Windmill supports.