commit 4d966052a22a4b5ebb9c0cc3c5a380482330014e
parent 75cb5695774224efbcb0babe892c5cde0e363f01
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Fri, 21 Feb 2020 13:08:27 +0100
sync README
Diffstat:
| M | README | | | 25 | +++++++++++++------------ |
1 file changed, 13 insertions(+), 12 deletions(-)
diff --git a/README b/README
@@ -148,23 +148,24 @@ CONFIG FILE
The following variables names are special with their respective default
values:
- filename
- The relative file path of the output HTML file for this page.
- The path is relative to the outputdir.
+ contentfile
+ Path to the input content filename, by default this is the path
+ of the config file with the last extension replaced to ".html".
- htmlfile
- Path to the input HTML content filename, by default this is the
- path of the config file with the last extension replaced to
- .html.
+ filename
+ The filename or relative file path for the output file for this
+ page. By default the value is the basename of the contentfile.
+ The path of the written output file is the value of filename
+ appended to the outputdir path.
- A line starting with # is ignored and can be used as a comment.
+ A line starting with # is a comment and is ignored.
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 config file can be used inside templates, but not
- pages.
+TEMPLATES
+ A template (block) is text. Variables are replaced with the values set
+ in the config files.
The possible operators for variables are:
@@ -184,7 +185,7 @@ TEMPLATE SYNTAX
<time datetime="${updated}">${updated}</time>
</p>
</header>
- %{htmlfile}
+ %{contentfile}
</article>
EXIT STATUS
