Skip to main content

A minimal theme for MkDocs

Project description

mkdocs-walt: a minimal documentation theme for MkDocs

Walt is a minimal documentation theme that is best suited for single page websites.

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 full usage example.

Acknowledgements

Walt uses writ.css for styles and Catppuccin for dark mode color palettes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-walt-0.0.4.dev0.tar.gz (4.7 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_walt-0.0.4.dev0-py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page