 |
update README, mention sbase/ubase - static-site-scripts - static site generato… |
 |
git clone git://git.codemadness.org/static-site-scripts |
 |
Log |
|
Files |
|
Refs |
|
README |
|
LICENSE |
|
--- |
|
commit 86117ef5bceb1de3cb6b394de263a422bc48fbd3 |
|
parent 8808dacf102ad05b393812cc2649fc7d41ac6875 |
|
Author: Hiltjo Posthuma <[email protected]> |
|
Date: Fri, 4 Mar 2016 16:26:22 +0100 |
|
|
|
update README, mention sbase/ubase |
|
|
|
Diffstat: |
|
M README.md | 35 ++++++++++++++++++++++-------… |
|
|
|
1 file changed, 25 insertions(+), 10 deletions(-) |
|
--- |
|
diff --git a/README.md b/README.md |
|
@@ -1,14 +1,19 @@ |
|
+static site scripts |
|
+=================== |
|
+ |
|
+ |
|
Usage |
|
-===== |
|
+----- |
|
|
|
sh generate.sh |
|
|
|
|
|
Features |
|
-======== |
|
+-------- |
|
|
|
- Small and simple to understand (I hope). |
|
-- Small amount of dependencies, requires a POSIX shell and basic Linux/Unix ut… |
|
+- Small amount of dependencies, requires a POSIX shell and basic Linux/Unix |
|
+ utilities[1][2]. |
|
- Markdown supported by default[0], easily extendable to add your |
|
\<favorite markup language\>. |
|
- RSS and Atom output support. |
|
@@ -16,11 +21,13 @@ Features |
|
|
|
|
|
Pages |
|
-===== |
|
+----- |
|
|
|
-Pages are defined as shellscripts containing the metadata (see pages/html-exam… |
|
-The content filename is the basename of the shellscript with the type of marku… |
|
-file appended to it (.html or .md), for example: pages/html-example.html . |
|
+Pages are defined as shellscripts containing the metadata, for example |
|
+the file pages/html-example.sh. |
|
+The content filename is the basename of the shellscript with the type of |
|
+markup file appended to it (.html or .md), for example the file |
|
+pages/html-example.html. |
|
|
|
Markdown is supported. By default "smu"[0] is set as a Markdown processor, |
|
to change this set $markdown to your favorite Markdown-to-HTML converter in |
|
@@ -28,13 +35,21 @@ the file generate.sh. |
|
|
|
|
|
Dependencies |
|
-============ |
|
+------------ |
|
|
|
cat, cut, date, mkdir, printf, read, sed, sh (POSIX), test, tr |
|
|
|
|
|
+License |
|
+------- |
|
+ |
|
+ISC, see LICENSE file. |
|
+ |
|
+ |
|
References |
|
-========== |
|
+---------- |
|
|
|
[0] smu - markdown processor: https://github.com/Gottox/smu |
|
-[1] busybox - http://www.busybox.net/ |
|
+[1] sbase - http://git.suckless.org/sbase/ |
|
+ ubase - http://git.suckless.org/ubase/ |
|
+[2] busybox - http://www.busybox.net/ |
