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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file mkdocs-walt-0.0.4.dev0.tar.gz.

File metadata

  • Download URL: mkdocs-walt-0.0.4.dev0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for mkdocs-walt-0.0.4.dev0.tar.gz
Algorithm Hash digest
SHA256 588a8582be4033af8ef1382862a43f7cdebc4b1f630a9bf906856064f9d3d4a6
MD5 b3f24bfce240a6eb925411dec4915a8f
BLAKE2b-256 eb3bf83883795457ab60bd6fefb732b101366810efbaf01bf1a60b09c13f0ff1

See more details on using hashes here.

File details

Details for the file mkdocs_walt-0.0.4.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_walt-0.0.4.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 dec3238aa7c9bcfa6a27248aa9f7efd6ec58b4ebb88bfc338303df5924fee5fe
MD5 45b93bcfacad7b870e6db319287604bf
BLAKE2b-256 53335597f9559b5a3e4f5e1444c9b88a296c82c7455a007fef76d618afd0aa69

See more details on using hashes here.

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