forked from alema/rivet
slightly better readme
This commit is contained in:
parent
796b66c3e0
commit
e109425557
28
README.md
28
README.md
@ -1,11 +1,37 @@
|
|||||||
# Rivet: static site genetator
|
# Rivet: static site genetator
|
||||||
River takes a source directory containing a the file sources and produces an
|
River takes a source directory containing a the file sources and produces an
|
||||||
output directoru that can actually be uploaded to a server.
|
output directory that can actually be uploaded to a server.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
- [lowdown](https://kristaps.bsd.lv/lowdown/)
|
- [lowdown](https://kristaps.bsd.lv/lowdown/)
|
||||||
|
- POSIX utilities
|
||||||
- POSIX sh
|
- POSIX sh
|
||||||
|
|
||||||
|
## 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}
|
||||||
|
```
|
||||||
|
|
||||||
## Similar tools
|
## Similar tools
|
||||||
|
|
||||||
- [saait](https://git.codemadness.org/saait/file/README.html)
|
- [saait](https://git.codemadness.org/saait/file/README.html)
|
||||||
|
Loading…
Reference in New Issue
Block a user