all repos — www @ e8fd06b449accb5886da0e3e4aca7211ceb45109

deserthorns.net content + generator

readme.md (view raw)

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
This repo contains the content and generator for [deserthorns.net](https://deserthorns.net/).

## Generator (`build`)
The site generator is written in Go and lives in the `build` directory.

### Requirements

Go 1.23.4

### Usage

`./build <ROOT>`

`<ROOT>` should be a path to the site's source directory.  The source directory must contain the following subdirectories and files:
- `wiki/`
- `assets`
- `index.html`

If `<ROOT>` is omitted, the current directory will be used as the source directory.

Generated files will be dropped in an `/out` directory in the working directory.


#### Flags
- `--serve`, `-s`: Builds site, then serves built site on port 8000.  For previewing site, not for use in a live environment. Live environment should serve the static files from the `/out` directory.

#### Creating a new wiki page
Add a new name to `wiki.tab` at its proper place in the hierarchy and rerun `./build`. A new file will be created in the `/wiki/pages` source directory with the proper template tags.

### TODOs
- Fast rebuild when serving locally using `-s` (press Enter to rebuild?)
- Sitemap/index of all pages
- Use YAML for `wiki.tab`?
- Typography styling pass