~theorytoe/siva

static site generation toolchain with pandoc + make + rsync
Initial commit

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~theorytoe/siva
read/write
git@git.sr.ht:~theorytoe/siva

You can also use your local clone with git send-email.

#Siva

Siva is a static site generation toolchain designed to be used with Pandoc for generating static websites with markdown. Siva also has a simple pre-compliation jobs via executables and content syncing with remotes.

Siva is packaged with sample site to demonstrate how to use it.

#Features

  • GNU Make integration for generating html files following the source directory tree.
  • Pre-compliation job via bootstrap/init, simply speciallized shell scripts.
  • Pandoc lua filters builtin.
  • Serve content easily to a remote server via rsync

#Usage:

this is a tool meant to be used for your own sites! You can install a bare layout with the following.

# clone repo and cd into it
git clone https://git.sr.ht/~theorytoe/siva /path/to/site
cd /path/to/site
# remove git objects
sudo rm -rf .git

Build markdown source files in src/ bootstrap jobs are automatically ran before compiling source markdown files.

make

Manually run bootstrap scripts (without compiling markdown files)

make bootstrap

Preview local copy of site in browser (via xdg-open)

make test

Sync build with remote server (user/hostname/port must be changed in the makefile) requires rsync.

make sync

Clean the build directory with

make clean

#Contributing

Want to help? Send patches to the mailing list: ~theorytoe/public-inbox@lists.sr.ht. Thanks!

Have a problem? Open a ticket on the tracker!