CustomMill theme for MkDocs

Another iteration on the awesome Windmill theme for MkDocs. This is permitted by the MIT License.

Highlights:

• Clean navigation for large documentation projects
• Retains the state of the menu across page transitions
• Versatile search with term highlighting in a quick search and on its own page
• Supports syntax highlighting within pages
• Deep nesting of pages in folders

Improvements over Windmill

• Customizable colors!
• Customizable links in the navigation menu
• A lot of small stylistic and design fixes
• Better search result listing
• Bootstrap 5 and no more jQuery

Quick start

To install using pip:

pip install mkdocs-custommill

To use in mkdocs.yml:

theme: custommill

Demo and documentation

See here for a demo and some documentation :)

Development

If doing development on mkdocs-custommill, check it out with

git clone https://github.com/Siphalor/mkdocs-custommill/
cd mkdocs-custommill