rivet: a simple static site generator
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alessandro Mauri f830437dfb Merge pull request 'correctly update title for current index page' (#3) from EmaMaker/rivet:master into master 1 year ago
.gitignore corrected usage information 4 years ago
LICENSE updated copyright 3 years ago
README.md tweaks to documentation 4 years ago
TODO updated copyright 3 years ago
makefile removed find -regex and merged pattern into awk command 3 years ago
rivet.1 version 0.3 3 years ago
rivet.sh correctly update title for current index page 1 year ago


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.



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
DOMAIN = alemauri.eu

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

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

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

	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