commit 6e7bde7ef5413126cdfda1d14d36bd7a741bb6e6
parent ff69771b1aab36fe6aef7b91bb17db9efdf0dec6
Author: gearsix <gearsix@tuta.io>
Date: Thu, 25 Mar 2021 11:53:39 +0000
minor amendment to docs
Diffstat:
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/docs/suti.txt b/docs/suti.txt
@@ -18,7 +18,6 @@ DESCRIPTION
The used libraries are listed below for credit/reference.
suti can also be imported as a golang package to be used as a library.
- See suti-lib for details.
OPTIONS
-r path, -root path
@@ -48,6 +47,7 @@ OPTIONS
A suffix can be appended to each value to set the sort order: "-asc" (for
ascending), "-desc" (for descending). If not specified, this defaults to
"-asc".
+
-cfg file, -config file
A data file to provide default values for the above options (see CONFIG).
@@ -109,7 +109,12 @@ SUPPORTED LANGUAGES
- statix (.stx .statix), see https://gist.github.com/plugnburn/c2f7cc3807e8934b179e
EXAMPLES
- // TODO
+
+ suti -cfg ./suti.cfg -r templates/textfile.mst
+
+ suti -r homepage.hmpl -p head.hmpl -p body.hmpl -gd meta.json -d posts/*
+
+ see the examples/ directory in the suti repository for a cool example.
LIBRARIES
As stated above, all of these libraries do the hard work, suti just combines
@@ -120,8 +125,5 @@ LIBRARIES
- gopkg.in/yaml.v3
- github.com/cbroglie/mustache
-SEE ALSO
- libsuti(3)
-
AUTHORS
- gearsix <gearsix@tuta.io>