mkdocs

mkdocs-walt

🍃 Walt is a minimal documentation theme for MkDocs.

It has the following features:

• classless styles for semantic HTML based on writ.css
• light mode and dark mode based on system settings
• an emoji favicon for browsers that support svg site icons
• code syntax highlighting using highlight.js

Installation

pip install mkdocs-walt

Usage

Create a new MkDocs project with the mkdocs CLI and add the following your project's mkdocs.yml:

theme:
  name: walt

See the end to end example in the project's repository.

Defaults

Walt sets the following configurations by default:

site_emoji: 🍃
locale: en
theme_color: "hsl(0, 0%, 100%)"
theme_color_dark: "hsl(232, 23%, 18%)"
include_header: true
include_nav: true
highlightjs: true

License

Copyright © 2023 Suzen Fylke. Distributed under the MIT License.

Acknowledgements

Walt uses writ.css for styles and Catppuccin for code block syntax highlighting and dark mode color palettes.