README.md - static-site-scripts - static site generator shellscripts | |
git clone git://git.codemadness.org/static-site-scripts | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
README.md (1204B) | |
--- | |
1 static site scripts | |
2 =================== | |
3 | |
4 | |
5 Usage | |
6 ----- | |
7 | |
8 sh generate.sh | |
9 | |
10 | |
11 Features | |
12 -------- | |
13 | |
14 - Small and simple to understand (I hope). | |
15 - Small amount of dependencies, requires a POSIX shell and basic Linux/U… | |
16 utilities[1][2]. | |
17 - Markdown supported by default[0], easily extendable to add your | |
18 \<favorite markup language\>. | |
19 - RSS and Atom output support. | |
20 - Sitemap support (sitemap.xml and urllist.txt). | |
21 | |
22 | |
23 Pages | |
24 ----- | |
25 | |
26 Pages are defined as shellscripts containing the metadata, for example | |
27 the file pages/html-example.sh. | |
28 The content filename is the basename of the shellscript with the type of | |
29 markup file appended to it (.html or .md), for example the file | |
30 pages/html-example.html. | |
31 | |
32 Markdown is supported. By default "smu"[0] is set as a Markdown processo… | |
33 to change this set $markdown to your favorite Markdown-to-HTML converter… | |
34 the file generate.sh. | |
35 | |
36 | |
37 Dependencies | |
38 ------------ | |
39 | |
40 cat, cut, date, mkdir, printf, read, sed, sh (POSIX), test, tr | |
41 | |
42 | |
43 License | |
44 ------- | |
45 | |
46 ISC, see LICENSE file. | |
47 | |
48 | |
49 References | |
50 ---------- | |
51 | |
52 [0] smu - markdown processor: https://github.com/Gottox/smu | |
53 [1] sbase - http://git.suckless.org/sbase/ | |
54 ubase - http://git.suckless.org/ubase/ | |
55 [2] busybox - http://www.busybox.net/ |