rivet/README.md

39 lines
789 B
Markdown
Raw Normal View History

2020-09-09 00:37:08 +02:00
# Rivet: static site genetator
River takes a source directory containing a the file sources and produces an
2020-09-10 00:49:01 +02:00
output directory that can actually be uploaded to a server.
2020-09-09 00:37:08 +02:00
## Dependencies
- [lowdown](https://kristaps.bsd.lv/lowdown/)
2020-09-10 00:49:01 +02:00
- POSIX utilities
2020-09-09 00:37:08 +02:00
- POSIX sh
2020-09-10 00:49:01 +02:00
## Examples
Generate site from directory to `cool_site`
```sh
2020-09-10 01:01:12 +02:00
$ rivet -o cool-site/ secret-sauce/ cool-url
2020-09-10 00:49:01 +02:00
```
The makefile I use to generate my site
```make
SRCDIR = src
DESTDIR = dst
2020-09-10 01:01:12 +02:00
DOMAIN = alemauri.eu
2020-09-10 00:49:01 +02:00
all:
2020-09-10 01:01:12 +02:00
rivet -o ${DESTDIR} ${SRCDIR} ${DOMAIN}
2020-09-10 00:49:01 +02:00
test: all
xdg-open ${DESTDIR}/index.html
install: all
2020-09-10 01:01:12 +02:00
rsync -vmruLz --delete ${DESTDIR}/ www@${DOMAIN}:/www/
2020-09-10 00:49:01 +02:00
clean:
rm -rf ${DESTDIR}
```
2020-09-09 00:37:08 +02:00
## Similar tools
- [saait](https://git.codemadness.org/saait/file/README.html)
- [ssg](https://www.romanzolotarev.com/ssg.html)