all repos — www @ 71b472af34a672776473adc2085f885c45daee7d

deserthorns.net content + generator

build/readme.md (view raw)

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
## 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:
- `css/`: for CSS stylesheets
- `assets/`: for other assets (e.g. images, files...)
- `site/`: for site pages.  The structure of this subdirectory determines the structure of the site itself.
- `templates/`: for reused markup.
- `site.tab`: this defines the structure of the site shown in the header nav. Each line should be a name of a file in the `site` directory (without the `.html` extension). Hierarchy is denoted by spaces preceding the page name.  If a corresponding file does not exist in `site` for a given name, a new file will be created in `site`. Therefore the best approach for adding a new page is to add its name to `site.tab`, then rebuild: this way the new page file will be created automatically with the proper template tags.

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


### Flags
- `--serve`, `-s`: Builds site, then serves built site on port 8000.  For previewing site, not for use in a live environment.