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.3.dev0.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs-walt-0.0.3.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.3.dev0.tar.gz
Algorithm Hash digest
SHA256 a7630b86c0aacd0766236f997119bb98d1322872e097ece9831e414dfcd53948
MD5 d6ed77fce6cf7a9d633d717be5106264
BLAKE2b-256 5dbe4b7d83c2bb661887a4ec74694a0509eeb12ed44a049cd2e80ddeabf60781

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_walt-0.0.3.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 c06b499f6362f8c04ea96f38cbff83f2ad05d4794feee887f2b7957791e030a5
MD5 1981a421f53a81c87302fb1d64904d22
BLAKE2b-256 61aa771d9d5975a5bee626a784d9d1265118d1526c9b37dcf7cc46072d17e35a

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