walt.css v0.1.1

walt

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.

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

You can install it from PyPI using:

pip install mkdocs-walt

See the mkdocs directory to learn how to install and use Walt in your MkDocs projects.

Developing mkdocs-walt

Installing from source

git clone https://github.com/codesue/walt.git
cd walt/mkdocs
pip install -e .

Running the example

cd ../examples/mkdocs  # if your current working directory is walt/mkdocs
mkdocs serve

Building and distributing the package

1. Install the necessary packages:

pip install "clementine[rind]"

2. With walt/mkdocs as your working directory, build the package and verify the build:

python -m build
twine check dist/*

3. Upload the package to TestPyPI:

twine upload -r testpypi dist/*

Install the package from TestPYPI in a clean virtual environment and confirm that the example runs as expected:

pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ mkdocs-walt

4. Upload the package to PyPI:

twine upload dist/*

License

Copyright © 2023 Suzen Fylke. Distributed under the MIT License.

Acknowledgements

Walt uses writ.css for styles and examples use writ's reference html page.

Walt also uses Catppuccin for code block syntax highlighting and dark mode color palettes.