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.
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.
Metadata
Release files for mkdocs-walt 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-walt-0.1.1.tar.gz | 44.7 kB | Without provenance | Details for mkdocs-walt-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_walt-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_walt-0.1.1-py3-none-any.whl |
Total release size: 90.6 kB
Release files / mkdocs-walt-0.1.1.tar.gz
| Download URL | mkdocs-walt-0.1.1.tar.gz |
|---|---|
| Size | 44.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
01e426980d128778ea061bc18f059044766119cf7b3168b4df769218485cb4e3
|
|
BLAKE2b-256 checksum How to use checksums |
e0c6f281b3f8a5b90ac89b7a997a7fb9e7d9c5d1683a00eebe3a3b83c2df36ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Release files / mkdocs_walt-0.1.1-py3-none-any.whl
| Download URL | mkdocs_walt-0.1.1-py3-none-any.whl |
|---|---|
| Size | 46.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bb57fbc96d25a8b5aded17391c39d4c9381ebebced1f8fef8699c340a1c5753d
|
|
BLAKE2b-256 checksum How to use checksums |
cb264237a8b2d6daa42d1b0f18a5889f4f3cae32906e8b8877efe1551e7a0951
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.9
|
Security for mkdocs-walt 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.