saait.1 and README: reword and correct a few things - 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 9203853d55254af37158617b4595d51888fa6951
(DIR) parent 88d494680432fbd4166b0a24226efd310aeb85e5
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Tue, 7 Jan 2020 18:23:02 +0100
saait.1 and README: reword and correct a few things
Diffstat:
M README | 20 ++++++++++----------
M saait.1 | 18 ++++++++----------
2 files changed, 18 insertions(+), 20 deletions(-)
---
(DIR) diff --git a/README b/README
@@ -42,6 +42,8 @@ See the man page of saait(1).
Man page
--------
+SAAIT(1) General Commands Manual SAAIT(1)
+
NAME
saait the most boring static page generator
@@ -109,7 +111,7 @@ CFG FILE
title=Example page
description=This is an example page
created=2009-04-12
- updated=2009-04-12
+ updated=2009-04-14
The following variables names are special with their respective default
values:
@@ -140,7 +142,7 @@ TEMPLATE SYNTAX
% Insert contents of file of the value of the variable.
- For example in a HTML template:
+ For example in a HTML item template:
<article>
<header>
@@ -172,8 +174,7 @@ EXAMPLES
cd newsite/
- 4. Adjust the values in the global config.cfg file which provides
- defaults for all pages.
+ 4. Change the values in the global config.cfg file.
5. If you want to modify parts of the header, like the navigation menu
items, you can change the following two template files:
@@ -181,8 +182,7 @@ EXAMPLES
templates/index.html/header.html
6. Create any new pages in the pages directory. For each *.cfg file
- there has to be a corresponding *.html file with the same basename.
- They have to be placed in the same folder. Optionally they can be
+ there has to be a corresponding *.html file. Optionally they can be
overridden with the special variable "htmlfile". See the copied
example pages in this directory.
@@ -207,9 +207,10 @@ EXAMPLES
rsync -av output/ user@somehost:/var/www/htdocs/
- Below is an example to use saait with Markdown. A possible method could
- be to just convert the Markdown to HTML and to run saait after that as
- usual.
+ Below is another example to use saait with Markdown:
+
+ A possible method could be to just convert the Markdown to HTML and to
+ run saait after that as usual.
In this example it uses smu for the Markdown processor, available at:
https://github.com/Gottox/smu :
@@ -229,4 +230,3 @@ SEE ALSO
AUTHORS
Hiltjo Posthuma <hiltjo@codemadness.org>
-
(DIR) diff --git a/saait.1 b/saait.1
@@ -1,4 +1,4 @@
-.Dd January 5, 2020
+.Dd January 7, 2020
.Dt SAAIT 1
.Os
.Sh NAME
@@ -72,7 +72,7 @@ filename=example.html
title=Example page
description=This is an example page
created=2009-04-12
-updated=2009-04-12
+updated=2009-04-14
.Ed
.Pp
The following variables names are special with their respective default values:
@@ -105,7 +105,7 @@ Literal raw string value.
Insert contents of file of the value of the variable.
.El
.Pp
-For example in a HTML template:
+For example in a HTML item template:
.Bd -literal
<article>
<header>
@@ -140,8 +140,7 @@ Change the current directory to the created directory.
cd newsite/
.Ed
.It
-Adjust the values in the global config.cfg file which provides defaults for
-all pages.
+Change the values in the global config.cfg file.
.It
If you want to modify parts of the header, like the navigation menu items,
you can change the following two template files:
@@ -153,9 +152,7 @@ templates/index.html/header.html
.El
.It
Create any new pages in the pages directory.
-For each *.cfg file there has to be a corresponding *.html file with the same
-basename.
-They have to be placed in the same folder.
+For each *.cfg file there has to be a corresponding *.html file.
Optionally they can be overridden with the special variable "htmlfile".
See the copied example pages in this directory.
.It
@@ -183,9 +180,10 @@ rsync -av output/ user@somehost:/var/www/htdocs/
.Ed
.El
.Pp
-Below is an example to use
+Below is another example to use
.Nm
-with Markdown.
+with Markdown:
+.Pp
A possible method could be to just convert the Markdown to HTML and to
run
.Nm