Skip to content
This repository has been archived by the owner on May 13, 2022. It is now read-only.

Outstanding mkdocs theme with a focus on navigation and usability

License

Notifications You must be signed in to change notification settings

noraj/mkdocs-windmill-dark

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

65 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Outstanding mkdocs theme with a focus on navigation and usability

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 53.6%
  • JavaScript 42.6%
  • HTML 3.3%
  • Other 0.5%