Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.13 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.13 KB

PyPI GitHub tag (latest SemVer)

Windmill Dark theme for MkDocs

A dark theme for MkDocs.

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-dark

To use in mkdocs.yml:

theme: windmill-dark

Demo and documentation

More details are on this site generated with the Windmill Dark theme:

  • Usage for more on installation and usage.
  • Customization for extra configuration options that Windmill Dark supports.