About

Walt is a minimal documentation theme based on writ.css. It features classless styles for semantic HTML and supports light and dark mode based on system settings.

Stylesheet

You can include the Walt stylesheet in your project in the following ways:

Copy the stylesheet from GitHub
Install from npm:

sh npm install --save walt.css
Link to a CDN:

html <link rel="stylesheet" href="https://unpkg.com/walt.css/walt.css" />

MkDocs theme

Walt is available as an MkDocs theme that 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

Installing with pip:

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

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

Acknowledgements

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