GitHub - gristlabs/mkdocs-windmill: Outstanding mkdocs theme with a focus on navigation and usability (original) (raw)

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:

Note that it's important for there to exist a homepage, e.g. a top-level root element in mkdocs 1.0+:

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.

Development

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

git clone https://github.com/gristlabs/mkdocs-windmill/ cd mkdocs-windmill

There are Selenium browser tests, based on NodeJS. To set them up, first install Yarn, then from mkdocs-windmill checkout, run

You can run tests when you make changes as follows:

cd tests MKDOCS_BINARY= SELENIUM_BROWSER=chrome yarn test