morpheus-site

morpheus.2f30.org website
git clone git://git.2f30.org/morpheus-site.git
Log | Files | Refs | README | LICENSE

README.md (1057B)


      1 What is this?
      2 =============
      3 
      4 These are the source files for the Morpheus Linux site: http://morpheus.2f30.org/
      5 
      6 
      7 Usage
      8 -----
      9 
     10 sh generate.sh
     11 
     12 Copy files in output/ to your virtual host directory.
     13 
     14 
     15 Features
     16 --------
     17 
     18 - Small and simple to understand (I hope).
     19 - Small amount of dependencies, requires a POSIX shell and basic Linux/Unix utilities[1].
     20 - Markdown supported by default[0], easily extendable to add your
     21   \<favorite markup language\>.
     22 
     23 
     24 Pages
     25 -----
     26 
     27 Pages are defined as shellscripts containing the metadata (see pages/html-example.sh).
     28 The content filename is the basename of the shellscript with the type of markup 
     29 file appended to it (.html or .md), for example: pages/html-example.html .
     30 
     31 Markdown is supported. By default "smu"[0] is set as a Markdown processor,
     32 to change this set $markdown to your favorite Markdown-to-HTML converter in
     33 the file generate.sh.
     34 
     35 
     36 Dependencies
     37 ------------
     38 
     39 cat, cut, date, mkdir, printf, read, sed, sh (POSIX), test, tr
     40 
     41 
     42 References
     43 ----------
     44 
     45 [0] smu - markdown processor: https://github.com/Gottox/smu