# mkdocs-walt
🍃 Walt is a minimal documentation theme for MkDocs.
It has the following features:
- classless styles for semantic HTML based on [writ.css](https://writ.cmcenroe.me)
- 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
<img src="https://raw.githubusercontent.com/codesue/walt/main/assets/images/mkdocs-walt-light.png" alt="Screenshot of the Walt website" />
## Installation
```sh
pip install mkdocs-walt
```
## Usage
Create a new MkDocs project with the `mkdocs` CLI and add the following your
project's `mkdocs.yml`:
```yaml
theme:
name: walt
```
See the [end to end example](https://github.com/codesue/walt/tree/main/examples/mkdocs).
## Defaults
Walt sets the following configurations by default:
```yaml
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](https://suzenfylke.com). Distributed under the MIT License.
## Acknowledgements
Walt uses [writ.css](https://github.com/programble/writ/tree/master) for styles
and [Catppuccin](https://github.com/catppuccin/catppuccin) for code block syntax
highlighting and dark mode color palettes.
Raw data
{
"_id": null,
"home_page": "https://github.com/codesue/walt",
"name": "mkdocs-walt",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mkdocs,mkdocs-theme,walt",
"author": "Suzen Fylke",
"author_email": "codesue@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/e0/c6/f281b3f8a5b90ac89b7a997a7fb9e7d9c5d1683a00eebe3a3b83c2df36ec/mkdocs-walt-0.1.1.tar.gz",
"platform": null,
"description": "# mkdocs-walt\n\n\ud83c\udf43 Walt is a minimal documentation theme for MkDocs.\n\nIt has the following features:\n\n- classless styles for semantic HTML based on [writ.css](https://writ.cmcenroe.me)\n- light mode and dark mode based on system settings\n- an emoji favicon for browsers that support svg site icons\n- code syntax highlighting using highlight.js\n\n<img src=\"https://raw.githubusercontent.com/codesue/walt/main/assets/images/mkdocs-walt-light.png\" alt=\"Screenshot of the Walt website\" />\n\n## Installation\n\n```sh\npip install mkdocs-walt\n```\n\n## Usage\n\nCreate a new MkDocs project with the `mkdocs` CLI and add the following your\nproject's `mkdocs.yml`:\n\n```yaml\ntheme:\n name: walt\n```\n\nSee the [end to end example](https://github.com/codesue/walt/tree/main/examples/mkdocs).\n\n## Defaults\n\nWalt sets the following configurations by default:\n\n```yaml\nsite_emoji: \ud83c\udf43\nlocale: en\ntheme_color: \"hsl(0, 0%, 100%)\"\ntheme_color_dark: \"hsl(232, 23%, 18%)\"\ninclude_header: true\ninclude_nav: true\nhighlightjs: true\n```\n\n## License\n\nCopyright © 2023 [Suzen Fylke](https://suzenfylke.com). Distributed under the MIT License.\n\n## Acknowledgements\n\nWalt uses [writ.css](https://github.com/programble/writ/tree/master) for styles\nand [Catppuccin](https://github.com/catppuccin/catppuccin) for code block syntax\nhighlighting and dark mode color palettes.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A minimal theme for MkDocs",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/codesue/walt"
},
"split_keywords": [
"mkdocs",
"mkdocs-theme",
"walt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb264237a8b2d6daa42d1b0f18a5889f4f3cae32906e8b8877efe1551e7a0951",
"md5": "b9c1b1a9c5aaef113652de99d286b647",
"sha256": "bb57fbc96d25a8b5aded17391c39d4c9381ebebced1f8fef8699c340a1c5753d"
},
"downloads": -1,
"filename": "mkdocs_walt-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9c1b1a9c5aaef113652de99d286b647",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 45967,
"upload_time": "2023-06-04T18:36:48",
"upload_time_iso_8601": "2023-06-04T18:36:48.730370Z",
"url": "https://files.pythonhosted.org/packages/cb/26/4237a8b2d6daa42d1b0f18a5889f4f3cae32906e8b8877efe1551e7a0951/mkdocs_walt-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e0c6f281b3f8a5b90ac89b7a997a7fb9e7d9c5d1683a00eebe3a3b83c2df36ec",
"md5": "1678ae7d00821be31731b90d11cd38da",
"sha256": "01e426980d128778ea061bc18f059044766119cf7b3168b4df769218485cb4e3"
},
"downloads": -1,
"filename": "mkdocs-walt-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1678ae7d00821be31731b90d11cd38da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44676,
"upload_time": "2023-06-04T18:36:50",
"upload_time_iso_8601": "2023-06-04T18:36:50.368042Z",
"url": "https://files.pythonhosted.org/packages/e0/c6/f281b3f8a5b90ac89b7a997a7fb9e7d9c5d1683a00eebe3a3b83c2df36ec/mkdocs-walt-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-04 18:36:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "codesue",
"github_project": "walt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-walt"
}
JSON
