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 81fd16023d link list is now in date order (hopefully) 10 months ago
.gitignore corrected usage information 1 year ago
LICENSE first commit 1 year ago
README.md tweaks to documentation 1 year ago
TODO more todos 10 months ago
makefile correct version in makefile 1 year ago
rivet.1 tweaks to documentation 1 year ago
rivet.sh link list is now in date order (hopefully) 10 months ago

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

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