Introduction
Introduction Statistics Contact Development Disclaimer Help
sync README - saait - the most boring static page generator
git clone git://git.codemadness.org/saait
Log
Files
Refs
README
LICENSE
---
commit 79f542131b02995e4bb1ba36e0f67b38c8551a35
parent 9789f45cbe96a0eb26621f7fb036a8a2db6daed8
Author: Hiltjo Posthuma <[email protected]>
Date: Sat, 15 Feb 2020 00:12:34 +0100
sync README
Diffstat:
M README | 48 ++++++++++++++++-------------…
1 file changed, 24 insertions(+), 24 deletions(-)
---
diff --git a/README b/README
@@ -70,8 +70,8 @@ SYNOPSIS
DESCRIPTION
saait writes HTML pages to the output directory.
- The arguments pages are page .cfg files, which are processed in the given
- order.
+ The arguments pages are page config files, which are processed in the
+ given order.
The options are as follows:
@@ -112,23 +112,23 @@ DIRECTORY AND FILE STRUCTURE
Footer block.
The files are saved as output/<templatename>, for example
- templates/atom.xml/* will become: output/atom.xml . If a filename does
- not exist then the template block is not processed and will be the same
- result as if it was an empty file.
+ templates/atom.xml/* will become: output/atom.xml . If a file for a
+ template block does not exist then it is treated as if it was an empty
+ file.
Hidden template directories (starting with ".") are ignored.
The templatename "page" is special and will be used per page.
-CFG FILE
- A .cfg file has a simple key=value configuration syntax, for example:
+CONFIG FILE
+ A config file has a simple key=value configuration syntax, for example:
- # an example page.
- filename=example.html
- title=Example page
- description=This is an example page
- created=2009-04-12
- updated=2009-04-14
+ # this is a comment line.
+ filename = example.html
+ title = Example page
+ description = This is an example page
+ created = 2009-04-12
+ updated = 2009-04-14
The following variables names are special with their respective default
values:
@@ -139,16 +139,16 @@ CFG FILE
htmlfile
Path to the input HTML content filename, by default this is the
- path of the .cfg file with .cfg replaced to .html.
-
- index If set to 0 then this page is not processed for templates except
- for the "page" template. This can be used to hide pages from
- templates such as index.html or from listing in an Atom feed.
+ path of the config file with the last extension replaced to
+ .html.
A line starting with # is ignored and can be used as a comment.
+ TABs and spaces before and after a variable name are ignored. TABs and
+ spaces before a value are ignored.
+
TEMPLATE SYNTAX
- The variables set in a .cfg file can be used inside templates, but not
+ The variables set in a config file can be used inside templates, but not
pages.
The possible operators for variables are:
@@ -198,10 +198,10 @@ EXAMPLES
templates/page/header.html
templates/index.html/header.html
- 6. Create any new pages in the pages directory. For each *.cfg f…
- there has to be a corresponding *.html file. Optionally they …
- overridden with the special variable "htmlfile". See the copied
- example pages in this directory.
+ 6. Create any new pages in the pages directory. For each config …
+ there has to be a corresponding html file. By default this html
+ file has the path of the config file, but with the last extension
+ (".cfg" in this case) replaced to ".html".
7. Create an output directory:
@@ -230,7 +230,7 @@ EXAMPLES
run saait after that as usual.
In this example it uses smu for the Markdown processor, available at:
- https://github.com/Gottox/smu :
+ https://github.com/Gottox/smu:
cd pages
for f in *.md; do
You are viewing proxied material from codemadness.org. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.