Add README
This commit is contained in:
parent
5d450e1e62
commit
9b5e826616
1 changed files with 17 additions and 0 deletions
17
README.md
Normal file
17
README.md
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
# arnes.space
|
||||||
|
|
||||||
|
This repository contains the source files for https://arnes.space. It uses [eleventy](https://www.11ty.dev/docs/) and [pnpm](https://pnpm.io/) to build a static website from a bunch of files that you can find in the `src/` folder.
|
||||||
|
|
||||||
|
## Available Commands
|
||||||
|
|
||||||
|
``` sh
|
||||||
|
# build the complete site
|
||||||
|
pnpm build
|
||||||
|
|
||||||
|
# run a local server that automatically changes as you update content
|
||||||
|
pnpm start # is the same as `pnpm watch`
|
||||||
|
```
|
||||||
|
|
||||||
|
## Build Environment
|
||||||
|
|
||||||
|
The build environment is described in `flake.{nix,lock}` and `.envrc`. You can use [direnv](https://direnv.net/) and [nix with flakes support](https://nixos.org/) to automatically drop into a shell that contains all tools for building the website.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue