quickshell-docs/README.md

# quickshell-docs

Documentation for [quickshell](https://git.outfoxxed.me/outfoxxed/quickshell).

Hosted version at [quickshell.outfoxxed.me](https://quickshell.outfoxxed.me).

# Building the documentation

The docs depend on:
- just
- hugo
- rust

To build the documentation you must be in a subdirectory of the main quickshell repo,
which is where the submodule clones this repo.

Run the following command to build and serve the docs locally:
```
$ just serve
```