hosted-by-chobble/vegan-prestwich
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source 
Fixing instructions
This commit is contained in:
stefan burke 2024-11-27 10:03:11 +00:00
parent 1bec9aff25
commit 7bcfcb8b7f
1 changed files with 12 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -10,11 +10,9 @@ Feel free to make a pull request, or join the discussion on [Facebook](https://w
## Building This Site ## Building This Site
This site is built with [Eleventy](https://www.11ty.dev) and deployed using [Nix / Nixos](https://nixos.org/), using [Sourcehut's build engine](https://builds.sr.ht), then deployed to [Neocities](https://neocities.org/) using their CLI. This site is built with [Eleventy](https://www.11ty.dev) and deployed using [Nix / Nixos](https://nixos.org/)
There are three scripts inside `/bin` - `build`, `serve` and `upgrade`. They each use `nix-shell` to fetch the tools they need. ### default.nix [(link)](https://git.chobble.com/chobble/vegan-prestwich/src/branch/master/default.nix)
### ./bin/build [(link)](https://git.sr.ht/~stfn/vegan-prestwich/tree/master/item/bin/build)
- deletes `_site` folder - deletes `_site` folder
- creates `_site/style` - creates `_site/style`
@ -22,17 +20,15 @@ There are three scripts inside `/bin` - `build`, `serve` and `upgrade`. They eac
- minifies and adds vendor prefixes to the CSS using `lightningcss` - minifies and adds vendor prefixes to the CSS using `lightningcss`
- builds the site to HTML using Eleventy, into `_site` - builds the site to HTML using Eleventy, into `_site`
- minifies the HTML using `html-minifier` - minifies the HTML using `html-minifier`
- sets `NEOCITIES_API_KEY` from a Sourcehut secret - copies the output to `$out`
- pushes the whole site to Neocities
### ./bin/serve [(link)](https://git.sr.ht/~stfn/vegan-prestwich/tree/master/item/bin/serve) ### shell.nix [(link)](https://git.chobble.com/chobble/vegan-prestwich/src/branch/master/shell.nix)
- deletes `_site` folder - if you call `serve`:
- creates `_site/style` - deletes `_site` folder
- compiles the SCSS in `style` to CSS in `_site/style` - creates `_site/style`
- builds the site to HTML using Eleventy, into `_site` - compiles the SCSS in `style` to CSS in `_site/style`
- serves it up on http://localhost:8080 - builds the site to HTML using Eleventy, into `_site`
- serves it up on http://localhost:8080
### ./bin/upgrade [(link)](https://git.sr.ht/~stfn/vegan-prestwich/tree/master/item/bin/upgrade) - if you call `upgrade_deps`:
- upgrades the `yarn.lock` file to the latest version of Eleventy
- upgrades the `pnpm-lock.yaml` file to the latest version of Eleventy