Outstanding mkdocs theme with a focus on navigation and usability, from Grist Labs.
Highlights:
To install using pip
:
pip install mkdocs-windmill
To use in mkdocs.yml
:
theme: windmill
Note that it's important for there to exist a homepage, e.g. a top-level root element in mkdocs 1.0+:
nav:
- Home: index.md
More details are on this site generated with the Windmill theme:
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
cd tests
yarn install
You can run tests when you make changes as follows:
cd tests
MKDOCS_BINARY=<path-to-mkdocs-command> SELENIUM_BROWSER=chrome yarn test