Update README and upgrade packages
This commit is contained in:
parent
592fa6d673
commit
638138fd2c
29
README.md
29
README.md
|
@ -6,3 +6,32 @@ Feel free to make a pull request, or join the discussion on [Facebook](https://w
|
|||
|
||||
* [VeganPrestwich.co.uk](https://veganprestwich.co.uk)
|
||||
* [Facebook Group](https://www.facebook.com/groups/veganprestwich/)
|
||||
|
||||
## 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.
|
||||
|
||||
There are three scripts inside `/bin` - `build`, `serve` and `upgrade`. They each use `nix-shell` to fetch the tools they need.
|
||||
|
||||
### ./bin/build
|
||||
|
||||
- deletes `_site` folder
|
||||
- creates `_site/style`
|
||||
- compiles the SCSS in `style` to CSS in `_site/style`
|
||||
- minifies and adds vendor prefixes to the CSS using `lightningcss`
|
||||
- builds the site to HTML using Eleventy, into `_site`
|
||||
- minifies the HTML using `html-minifier`
|
||||
- sets `NEOCITIES_API_KEY` from a Sourcehut secret
|
||||
- pushes the whole site to Neocities
|
||||
|
||||
### ./bin/serve
|
||||
|
||||
- deletes `_site` folder
|
||||
- creates `_site/style`
|
||||
- compiles the SCSS in `style` to CSS in `_site/style`
|
||||
- builds the site to HTML using Eleventy, into `_site`
|
||||
- serves it up on http://localhost:8080
|
||||
|
||||
### ./bin/upgrade
|
||||
|
||||
- upgrades the `pnpm-lock.yaml` file to the latest version of Eleventy
|
||||
|
|
|
@ -121,7 +121,7 @@ packages:
|
|||
bcp-47-normalize: 2.3.0
|
||||
chardet: 2.0.0
|
||||
chokidar: 3.6.0
|
||||
cross-spawn: 7.0.3
|
||||
cross-spawn: 7.0.5
|
||||
debug: 4.3.7
|
||||
dependency-graph: 1.0.0
|
||||
entities: 5.0.0
|
||||
|
@ -634,8 +634,8 @@ packages:
|
|||
resolution: {integrity: sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==}
|
||||
dev: false
|
||||
|
||||
/cross-spawn@7.0.3:
|
||||
resolution: {integrity: sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==}
|
||||
/cross-spawn@7.0.5:
|
||||
resolution: {integrity: sha512-ZVJrKKYunU38/76t0RMOulHOnUcbU9GbpWKAOZ0mhjr7CX6FVrH+4FrAapSOekrgFQ3f/8gwMEuIft0aKq6Hug==}
|
||||
engines: {node: '>= 8'}
|
||||
dependencies:
|
||||
path-key: 3.1.1
|
||||
|
@ -915,7 +915,7 @@ packages:
|
|||
resolution: {integrity: sha512-Ld2g8rrAyMYFXBhEqMz8ZAHBi4J4uS1i/CxGMDnjyFWddMXLVcDp051DZfu+t7+ab7Wv6SMqpWmyFIj5UbfFvg==}
|
||||
engines: {node: '>=14'}
|
||||
dependencies:
|
||||
cross-spawn: 7.0.3
|
||||
cross-spawn: 7.0.5
|
||||
signal-exit: 4.1.0
|
||||
dev: false
|
||||
|
||||
|
|
Loading…
Reference in a new issue