doc: explain how to build & check the docs locally (#1273)

This commit is contained in:
pancho horrillo 2025-05-18 01:20:44 +02:00 committed by GitHub
parent 3c172cbbc6
commit 91b23c7bc6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -57,3 +57,16 @@ stylix-check
```
This is based on [`nix-fast-build`](https://github.com/Mic92/nix-fast-build#readme).
## Documentation
The documentation in the `docs` subtree gets
[published](https://stylix.danth.me) automatically, using GitHub Actions.
If you modify it, you can easily build it and check your changes locally:
```sh
nix build .#docs
xdg-open result/index.html
```