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
|
|
|
|
|
$ rivet -o cool_site source_of_cool_site/
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The makefile I use to generate my site
|
|
|
|
|
```make
|
|
|
|
|
SRCDIR = src
|
|
|
|
|
DESTDIR = dst
|
|
|
|
|
|
|
|
|
|
all:
|
|
|
|
|
mkdir -p ${DESTDIR}
|
|
|
|
|
ssg -o ${DESTDIR} ${SRCDIR}
|
|
|
|
|
|
|
|
|
|
test: all
|
|
|
|
|
xdg-open ${DESTDIR}/index.html
|
|
|
|
|
|
|
|
|
|
install: all
|
|
|
|
|
rsync -vmruLz --delete ${DESTDIR}/ www@${URL}:/www/
|
|
|
|
|
|
|
|
|
|
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)
|
