alema/rivet
1
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity
rivet: a simple static site generator
21 Commits 1 Branch 0 Tags 185 KiB
Shell 69.8%
Roff 26.9%
Makefile 3.3%
4c6f06b6b7
Go to file
Alessandro Mauri 4c6f06b6b7 version 0.2 
changes:
	- rivet now generates an atom feed with the last 3 (configurable)
		modified articles
	- rivet now generates links in the index list to html files in srcdir
	- Articles with unkown title will have their filename as the title
	- minor code refractor
2021-03-21 14:22:20 +01:00
.gitignore corrected usage information 2020-09-10 16:23:58 +02:00
LICENSE first commit 2020-09-09 00:37:08 +02: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 version 0.2 2021-03-21 14:22:20 +01:00
rivet.sh version 0.2 2021-03-21 14:22:20 +01:00
TODO version 0.2 2021-03-21 14:22:20 +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

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