Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gristlabs/mkdocs-windmill
Outstanding mkdocs theme with a focus on navigation and usability
https://github.com/gristlabs/mkdocs-windmill
Last synced: 5 days ago
JSON representation
Outstanding mkdocs theme with a focus on navigation and usability
- Host: GitHub
- URL: https://github.com/gristlabs/mkdocs-windmill
- Owner: gristlabs
- License: other
- Created: 2017-05-15T03:51:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T08:16:24.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T14:38:21.378Z (about 1 month ago)
- Language: CSS
- Size: 2.22 MB
- Stars: 105
- Watchers: 4
- Forks: 63
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - gristlabs/mkdocs-windmill - Outstanding mkdocs theme with a focus on navigation and usability (others)
README
[![PyPI][pypi-image]][pypi-link]
[pypi-image]: https://img.shields.io/pypi/v/mkdocs-windmill.svg
[pypi-link]: https://pypi.python.org/pypi/mkdocs-windmill
# 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`:
``` sh
pip install mkdocs-windmill
```
To use in `mkdocs.yml`:
``` yaml
theme: windmill
```
Note that it's important for there to exist a homepage, e.g. a top-level root element in mkdocs 1.0+:
``` yaml
nav:
- Home: index.md
```
## Demo and documentation
More details are on this site generated with the Windmill theme:
- [Usage](https://gristlabs.github.io/mkdocs-windmill/#) for more on installation and usage.
- [Customization](https://gristlabs.github.io/mkdocs-windmill/#customization/) for extra configuration options that Windmill supports.
## Development
If doing development on `mkdocs-windmill`, check it out with
``` sh
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](https://yarnpkg.com/en/docs/install), then from `mkdocs-windmill` checkout, run
``` sh
cd tests
yarn install
```
You can run tests when you make changes as follows:
``` sh
cd tests
MKDOCS_BINARY= SELENIUM_BROWSER=chrome yarn test
```