Skip to content

Commit

Permalink
Docfix
Browse files Browse the repository at this point in the history
  • Loading branch information
codesue committed Jun 1, 2023
1 parent 3359f5e commit 7c53e03
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 36 deletions.
36 changes: 5 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,58 +5,32 @@
[![GitHub][github_badge]][github_link]
[![Docs][docs_badge]][docs_link]

🍃 Walt is a minimal documentation theme based on [writ.css](https://writ.cmcenroe.me).

Walt is a minimal documentation theme based on [writ.css](https://writ.cmcenroe.me).
It features classless styles for semantic HTML and supports light and dark mode
based on system settings.

Walt is available as an [MkDocs theme](#mkdocs-theme) that you can install from PyPI.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/images/mkdocs-walt-dark.png" />
<img src="assets/images/mkdocs-walt-light.png" alt="Screenshot of the Walt website" />
</picture>

## MkDocs theme

The Walt theme for MkDocs features:
Walt is available as an MkDocs theme that 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

### Installation
You can install it from PyPI using:

```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
```
See the [`mkdocs-walt`](https://github.com/codesue/walt/blob/main/mkdocs-walt)
directory to learn how to install and use Walt in your MkDocs projects.

### Developing mkdocs-walt

Expand Down
7 changes: 2 additions & 5 deletions examples/mkdocs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
# About

🍃 Walt is a minimal documentation theme based on [writ.css](https://writ.cmcenroe.me).

Walt is a minimal documentation theme based on [writ.css](https://writ.cmcenroe.me).
It features classless styles for semantic HTML and supports light and dark mode
based on system settings.

Walt is available as an [MkDocs theme](#mkdocs-theme`) that you can install from PyPI.

## MkDocs theme

The Walt theme for MkDocs features:
Walt is available as an MkDocs theme that features:

- classless styles for semantic HTML based on [writ.css](https://writ.cmcenroe.me)
- light mode and dark mode based on system settings
Expand Down

0 comments on commit 7c53e03

Please sign in to comment.