Giter Site home page Giter Site logo

vokobe's Introduction

Vokobe

A minimal static site generator tailored to my needs.

CI: https://hydra.emile.space/project/vokobe

Build

; cargo build --release

Usage/Examples

; ./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.

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.

rsync -avz --delete <out-path>/* <user>@<host>:<path>

publish.sh

Build and Syncronize.

./build.sh
./sync.sh

host.sh

Host the local version

python3 -m http.server 8081 -d <outpath>/ -b 0.0.0.0

watchbuild.sh

rebuild on changes

#! /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.

sh ./watchbuild.sh &
sh ./host.sh

Contributing

Send patches!

vokobe's People

Contributors

hanemile avatar shoebham avatar

Stargazers

 avatar Ludwig Cornely avatar Michael Yang avatar tarneo avatar Mariano Portal avatar

Watchers

 avatar  avatar Ludwig Cornely avatar

Forkers

shoebham

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.