commit 4a974d5c74111b244f359c51a5adf37e13a54d86 parent 1ad12edc7092593171dba5c0f86b7892d030617a Author: Hiltjo Posthuma <hiltjo@codemadness.org> Date: Fri, 28 Feb 2014 12:43:33 +0100 update README Signed-off-by: Hiltjo Posthuma <hiltjo@codemadness.org> Diffstat:
| M | README.md | | | 25 | ++++++++++++++++++++----- |
1 file changed, 20 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md @@ -1,16 +1,31 @@ Usage ===== -sh generate.sh [configfile] +sh generate.sh -the default config file is ./site.conf + +Features +======== + +- Small and simple to understand (I hope). +- Small amount of dependencies, requires a POSIX shell and basic Linux/Unix utilities. +- Markdown supported by default, easily extendable to add your \<favorite template language\>. +- RSS and Atom output support. +- Sitemap support (sitemap.xml and urllist.txt). Pages ===== -Pages are defined as shellscripts containing metadata (see pages/example-page-template.sh). +Pages are defined as shellscripts containing metadata (see pages/html-example.sh). + +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 markdown2HTML converter. + -The page content is the basename of the shellscript + .html (see pages/example-page-template.html). Markdown should be supported, but is untested for now. +References +========== -\<insert you favorite template language\> can easily be added to generate.sh. +[0] smu - markdown processor: https://github.com/Gottox/smu