sync README - saait - the most boring static page generator
(HTM) git clone git://git.codemadness.org/saait
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 8d49f005a4bf2ed3812331dafd8090891960e86c
(DIR) parent d4a58cdd0964fdd4fee0e036bfbb06bd7e6f9c43
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Fri, 21 Feb 2020 15:18:51 +0100
sync README
Diffstat:
M README | 24 +++++++++++-------------
1 file changed, 11 insertions(+), 13 deletions(-)
---
(DIR) diff --git a/README b/README
@@ -36,7 +36,7 @@ Tested and works on
Example of a workflow
---------------------
-This script monitors pages for changes and for new files in the directory and
+This script monitors pages for changes and for new files in the directory then
regenerates static files if this happens. If successful then refreshes the
current window/tab in Firefox.
@@ -92,8 +92,8 @@ DESCRIPTION
-c configfile
The global configuration file, the default is "config.cfg". Each
- page configuration file inherits the values from this file. The
- values can be overwritten per page.
+ page configuration file inherits variables from this file. These
+ variables can be overwritten per page.
-o outputdir
The output directory, the default is "output".
@@ -102,14 +102,14 @@ DESCRIPTION
The templates directory, the default is "templates".
DIRECTORY AND FILE STRUCTURE
- A recommended directory structure for pages, but the names can be
+ A recommended directory structure for pages, although the names can be
anything:
pages/001-page.cfg
pages/001-page.html
pages/002-page.cfg
pages/002-page.html
- The directory and files structure for templates must be:
+ The directory and file structure for templates must be:
templates/<templatename>/header.ext
templates/<templatename>/item.ext
templates/<templatename>/footer.ext
@@ -127,13 +127,12 @@ 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 file for a
- template block does not exist then it is treated as if it was an empty
- file.
+ templates/atom.xml/* will become: output/atom.xml. If a template block
+ file does not exist then it is treated as if it was empty.
- Hidden template directories (starting with ".") are ignored.
+ Template directories starting with a dot (".") are ignored.
- The templatename "page" is special and will be used per page.
+ The "page" templatename is special and will be used per page.
CONFIG FILE
A config file has a simple key=value configuration syntax, for example:
@@ -145,8 +144,7 @@ CONFIG FILE
created = 2009-04-12
updated = 2009-04-14
- The following variables names are special with their respective default
- values:
+ The following variable names are special with their respective defaults:
contentfile
Path to the input content filename, by default this is the path
@@ -215,7 +213,7 @@ EXAMPLES
templates/index.html/header.html
6. Create any new pages in the pages directory. For each config file
- there has to be a corresponding html file. By default this html
+ 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".