diff options
| author |   Shankho Boron Ghosh <shankhoghosh123@gmail.com> | 2020-11-04 20:48:01 +0530 |
|---|---|---|
| committer |   Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-11-10 22:43:20 +0000 |
| commit | 6b1ab1c2161da3cd7a3d54fe684906e73da23674 (patch) | |
| tree | 43ffb329b1c418251e8fa7c140b3c5717c7365af /theme/README.md | |
| parent | d03401d2cdcddf2bc24f4eff0954f69fa5aa61ec (diff) | |
Added Icefish Branchicefish_9.0.4icefish/9.0.49.0.4icefish
Meta redirects to http://old-docs.automotivelinux.org/docs/en/icefish/getting_started/
Bug-AGL: [SPEC-3633]
Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ie6bfbc5821b8c158fb92a076d143d8e495ac5d89
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25509
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'theme/README.md')
| -rw-r--r-- | theme/README.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/theme/README.md b/theme/README.md new file mode 100644 index 0000000..cc443f6 --- /dev/null +++ b/theme/README.md @@ -0,0 +1,58 @@ +[![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=<path-to-mkdocs-command> SELENIUM_BROWSER=chrome yarn test +``` |