update readme
sageclove
Sat, 04 Jan 2025 12:38:34 -0700
1 files changed,
6 insertions(+),
5 deletions(-)
jump to
M
build/readme.md
→
build/readme.md
@@ -6,11 +6,12 @@ ## Usage
`./build <ROOT>` -`<ROOT>` should be a path to the site's source directory. The source directory must contain the following subdirectories: -- `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. +`<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.