diff options
author | Emile <git@emile.space> | 2024-08-16 23:33:53 +0200 |
---|---|---|
committer | Emile <git@emile.space> | 2024-08-16 23:33:53 +0200 |
commit | cea6896788a42c0ea40f99deb4b5987d6741e360 (patch) | |
tree | 7b65658ce082cab4f552b0a42fa171745f003bd2 /nix/pkgs/vokobe/README.md | |
parent | dcfc18774fe2d4207c2996b2d16ea67499b70228 (diff) |
big dump, forgot to commit...
Diffstat (limited to 'nix/pkgs/vokobe/README.md')
-rw-r--r-- | nix/pkgs/vokobe/README.md | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/nix/pkgs/vokobe/README.md b/nix/pkgs/vokobe/README.md new file mode 100644 index 0000000..c2c54a9 --- /dev/null +++ b/nix/pkgs/vokobe/README.md @@ -0,0 +1,101 @@ +# Vokobe + +A minimal static site generator tailored to my needs. + +CI: [https://hydra.emile.space/project/vokobe](https://hydra.emile.space/project/vokobe) + +## Build + +```bash +; cargo build --release +``` + +## Usage/Examples + +```bash +; ./target/release/vokobe --help +vokobe 0.1.0 +A static site generator + +USAGE: + vokobe [FLAGS] <in-path> <out-path> <site-name> + +FLAGS: + -a, --analytics Activate sending analytics to stats.emile.space + -h, --help Prints help information + -V, --version Prints version information + +ARGS: + <in-path> Input path + <out-path> Output path + <site-name> Site name (e.g. emile.space) +``` + + +## Deployment + +The following subsections contain some example for small shell scripts that might be useful for Deployment. + +### build.sh + +Remove the output dir, build it from scratch and update the perms. + +I'm actually considering rebuilding vokobe with incremental builds in mind, as it can take a bit to create some really large projects. + +```bash +rm -rf out/ +vokobe -a ./in ./out emile.space +chmod -R +r out/ +``` + +### sync.sh + +Syncronize the generated output to the remote host for hosting it. + +```bash +rsync -avz --delete <out-path>/* <user>@<host>:<path> +``` + +### publish.sh + +Build and Syncronize. + +```bash +./build.sh +./sync.sh +``` + +### host.sh + +Host the local version + +```bash +python3 -m http.server 8081 -d <outpath>/ -b 0.0.0.0 +``` + +### watchbuild.sh + +rebuild on changes + +```bash +#! /usr/bin/env nix-shell +#! nix-shell -i bash -p fd entr + +while sleep 0.5; do + fd . in | entr -d ./build.sh +done +``` + +### local.sh + +run a script updating it on changes and one hosting the output. + +```bash +sh ./watchbuild.sh & +sh ./host.sh +``` + + +## Contributing + +Send patches! |