1 [![PyPI][pypi-image]][pypi-link]
3 [pypi-image]: https://img.shields.io/pypi/v/mkdocs-windmill.svg
4 [pypi-link]: https://pypi.python.org/pypi/mkdocs-windmill
6 # Windmill theme for MkDocs
7 Outstanding mkdocs theme with a focus on navigation and usability, from Grist Labs.
10 - Convenient navigation for larger documentation projects.
11 - Retains state of the navigation menu across page transitions.
12 - Search with term highlighting.
13 - User may search in a quick dropdown or load results in a full page.
14 - Default mkdocs theme within pages, including syntax highlighting.
18 To install using `pip`:
20 pip install mkdocs-windmill
23 To use in `mkdocs.yml`:
28 Note that it's important for there to exist a homepage, e.g. a top-level root element in mkdocs 1.0+:
34 ## Demo and documentation
36 More details are on this site generated with the Windmill theme:
37 - [Usage](https://gristlabs.github.io/mkdocs-windmill/#) for more on installation and usage.
38 - [Customization](https://gristlabs.github.io/mkdocs-windmill/#customization/) for extra configuration options that Windmill supports.
42 If doing development on `mkdocs-windmill`, check it out with
44 git clone https://github.com/gristlabs/mkdocs-windmill/
48 There are Selenium browser tests, based on NodeJS. To set them up, first [install Yarn](https://yarnpkg.com/en/docs/install), then from `mkdocs-windmill` checkout, run
54 You can run tests when you make changes as follows:
57 MKDOCS_BINARY=<path-to-mkdocs-command> SELENIUM_BROWSER=chrome yarn test