c7551deff4aa — Nolan Prescott 2 years ago
Fix up documentation

 - briefly explain template syntax
 - provide defaults in generated config.ini to prevent errors if
   unconfigured
 - update email in setup.py
3 files changed, 34 insertions(+), 10 deletions(-)

M README.rst
M quiescent/bootstrap.py
M setup.py
M README.rst +30 -6
@@ 18,7 18,7 @@ the only parts of the resulting site tha
 *archive* of all posts.
 
 Quiescent uses `Mistune <https://github.com/lepture/mistune>`_ for markdown
-parsing, and Python 3.6 (for ``f``-string formatting).
+parsing, and Python 3.6.
 
 Installation
 ------------

          
@@ 44,14 44,38 @@ default ``config.ini``.
 In order for the program to run as intended, the ``config.ini`` file must be
 modified to suit the destination site.
 
-The following templates are required and included in the ``bootstrap`` command
-upon initial configuration:
+The following templates are required and included in the
+``--bootstrap`` command upon initial configuration:
 
  - archive.html
- - base.html
  - index.html
  - post.html
 
+Templates
+~~~~~~~~~
+
+Quiescent implements its own code-generating template engine. The
+intent is for the majority of a template to be plain HTML, with a
+small number of points for data (usually written post information) to
+be "injected". The syntax is summarized below, more examples are
+available in the sample templates provided by the ``--bootstrap``
+command:
+
+::
+
+   {{variable_name}}
+   
+   {{object.attribute}}
+
+   {% for item in iterable %}
+   {{item}}
+   {% endfor %}
+
+   {% if some_test %}
+   this text is conditional
+   {% endif %}
+   
+
 Tips for Writing
 ~~~~~~~~~~~~~~~~
 

          
@@ 61,7 85,7 @@ beginning of the markdown file. The form
 ::
 
    title: <post title>
-   date: <must match the configured date format>
+   date: <must match the date format in config.ini>
    +++
 
 An important note to keep in mind when writing posts, the links used in

          
@@ 80,7 104,7 @@ simply ``rsync``-ing the entire *build* 
 
 ::
 
-   cd build-directory
+   cd build
    rsync -avz . user@example.com:/static/file/directory
 
 

          
M quiescent/bootstrap.py +3 -3
@@ 21,9 21,9 @@ logger = logging.getLogger(__name__)
 def bootstrap():
     config = 'config.ini', """
 [STATIC]
-domain =
-name =
-author =
+domain = example.com
+name = Example Name
+author = Example Author
 output directory = build
 posts directory = posts
 media directory = media

          
M setup.py +1 -1
@@ 10,7 10,7 @@ setup(name="quiescent",
       long_description=readme(),
       url='https://github.com/NPrescott/quiescent',
       author='Nolan Prescott',
-      author_email='prescott.nolan@gmail.com',
+      author_email='quiescent@nprescott.com',
       license='GPL',
       packages=['quiescent'],
       install_requires=[