chore(docs): add quick tips to readme
This commit is contained in:
parent
98818bbad7
commit
9a4b698d68
1 changed files with 13 additions and 0 deletions
13
README.md
13
README.md
|
@ -2,6 +2,19 @@
|
||||||
|
|
||||||
[Hakyll](https://jaspervdj.be/hakyll/) + [Nix](https://nixos.org) template
|
[Hakyll](https://jaspervdj.be/hakyll/) + [Nix](https://nixos.org) template
|
||||||
|
|
||||||
|
## Quick tips
|
||||||
|
|
||||||
|
* Read the tutorial to get started! https://robertwpearce.com/the-hakyll-nix-template-tutorial.html
|
||||||
|
* If you make changes to anything inside of `ssg/`, you'll need to clean the
|
||||||
|
hakyll cache and rebuild. This is the preferred series of commands for
|
||||||
|
rebuilding (with logs), cleaning the cache, and re-running the dev server:
|
||||||
|
|
||||||
|
```default
|
||||||
|
nix build --print-build-logs && \
|
||||||
|
nix run . clean && \
|
||||||
|
nix run . watch
|
||||||
|
```
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Build your site into the `./result/dist` folder:
|
* Build your site into the `./result/dist` folder:
|
||||||
|
|
Loading…
Add table
Reference in a new issue