mkdocs-custommill 1.2.5

Improved and extended version of the Windmill theme

CustomMill theme for MkDocs

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

Highlights:

• Convenient navigation for larger documentation projects.
• Retains state of the navigation menu across page transitions.
• Deep nesting of documentation folders
• 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.
• Custom coloring through sass

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