rivet: a simple static site generator

Go to file

Alessandro Mauri 5ac9e2ae5f fixed date Before the date was taken on the destination files, since they are generated in the right order, lists based on last modified date were right but with the wrong date. Now rivet creates another list during the creation of the main object list just for storing dates of the source files. There is a 1:1 correspondance between the files in the objlist and the dates in the objdate lists so they can be retrived with the same counter. Another change is that now shortened dates are displayed in the index link list.		2021-06-11 16:01:05 +02: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	version 0.2	2021-03-21 14:22:20 +01:00
README.md	tweaks to documentation	2020-09-11 12:14:29 +02:00
rivet.1	option to include everything in atom feed	2021-06-08 12:29:02 +02:00
rivet.sh	fixed date	2021-06-11 16:01:05 +02: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