rivet: a simple static site generator

Go to file

Alessandro Mauri 8f1508e200 removed find -regex and merged pattern into awk command basically this means that rivet works on alpine (busybox)		2021-11-18 00:20:05 +01:00
.gitignore	corrected usage information	2020-09-10 16:23:58 +02:00
LICENSE	updated copyright	2021-03-27 23:07:05 +01:00
makefile	removed find -regex and merged pattern into awk command	2021-11-18 00:20:05 +01:00
README.md	tweaks to documentation	2020-09-11 12:14:29 +02:00
rivet.1	version 0.3	2021-06-12 13:08:51 +02:00
rivet.sh	removed find -regex and merged pattern into awk command	2021-11-18 00:20:05 +01:00
TODO	updated copyright	2021-03-27 23:07:05 +01:00

README.md

Rivet: static site genetator

Rivet is a static site generator that takes a directory containing markdown markdown files (and a couple special ones) and generates an output directory that can be uploaded to a server.

Rivet uses lowdown(1) to convert the markdown files to html, as such refer to the lowdown(5) manpage for the details of the dialect of markdown and the possible metadata that it can parse.

Dependencies

lowdown
POSIX utilities
POSIX sh

Examples

Generate site from directory to cool_site

$ rivet -o cool-site/ secret-sauce/ cool-url

The makefile I use to generate my site

SRCDIR = src
DESTDIR = dst
DOMAIN = alemauri.eu

all:
	rivet -o ${DESTDIR} ${SRCDIR} ${DOMAIN}

test: all
	xdg-open ${DESTDIR}/index.html

install: all
	rsync -vmruLz --delete ${DESTDIR}/ www@${DOMAIN}:/www/

clean:
	rm -rf ${DESTDIR}

The source directory

The source directory tree should at least contain:

index.md: will be converted to index.html
_header.html: contains the stuff to be placed inside all headers
_footer.html: contains the stuff to be placed inside all footers

Obviously anything can go in the source direcory, keep in mind that everything that is not markdown files will be just copied over.

Similar tools

saait
ssg