 |
update README: add dependency info - static-site-scripts - static site generato… |
 |
git clone git://git.codemadness.org/static-site-scripts |
 |
Log |
|
Files |
|
Refs |
|
README |
|
LICENSE |
|
--- |
|
commit e6a8d78a5f661e240dc0f2c61e271975d4b0f2e3 |
|
parent 529ef6166656b8a5021cffdd9b9f73741203d2b4 |
|
Author: Hiltjo Posthuma <[email protected]> |
|
Date: Wed, 5 Mar 2014 21:05:52 +0100 |
|
|
|
update README: add dependency info |
|
|
|
Signed-off-by: Hiltjo Posthuma <[email protected]> |
|
|
|
Diffstat: |
|
M README.md | 21 +++++++++++++++------ |
|
|
|
1 file changed, 15 insertions(+), 6 deletions(-) |
|
--- |
|
diff --git a/README.md b/README.md |
|
@@ -8,8 +8,9 @@ Features |
|
======== |
|
|
|
- Small and simple to understand (I hope). |
|
-- Small amount of dependencies, requires a POSIX shell and basic Linux/Unix ut… |
|
-- Markdown supported by default, easily extendable to add your \<favorite temp… |
|
+- Small amount of dependencies, requires a POSIX shell and basic Linux/Unix ut… |
|
+- Markdown supported by default[0], easily extendable to add your |
|
+ \<favorite markup language\>. |
|
- RSS and Atom output support. |
|
- Sitemap support (sitemap.xml and urllist.txt). |
|
|
|
@@ -17,15 +18,23 @@ Features |
|
Pages |
|
===== |
|
|
|
-Pages are defined as shellscripts containing metadata (see pages/html-example.… |
|
+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 . |
|
|
|
-The page content is the basename of the shellscript + .html or .md |
|
+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 |
|
+the file generate.sh. |
|
|
|
-Markdown is supported. By default "smu"[0] is set as a markdown processor, |
|
-to change this set $markdown to your favorite markdown2HTML converter. |
|
+ |
|
+Dependencies |
|
+============ |
|
+ |
|
+cat, cut, date, mkdir, printf, read, sed, sh (POSIX), test, tr |
|
|
|
|
|
References |
|
========== |
|
|
|
[0] smu - markdown processor: https://github.com/Gottox/smu |
|
+[1] busybox - http://www.busybox.net/ |
