diff options
| author | Starfall <us@starfall.systems> | 2021-10-23 12:47:20 -0500 |
|---|---|---|
| committer | Starfall <us@starfall.systems> | 2023-12-05 10:00:32 -0600 |
| commit | 2eb81abb648d497b8b9e497ec00d58a893f3727e (patch) | |
| tree | 3bc15bc49919c3dc7785f34f2d6298c25b29911d /README | |
| parent | 6476982874fec8a7e0e77b0f0484c7c8c0c56ea9 (diff) | |
strike: statement of intent for a few more variables
Diffstat (limited to 'README')
| -rw-r--r-- | README | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/README b/README index f8aefaa..93fac3e 100644 --- a/README +++ b/README @@ -24,7 +24,7 @@ And some stretch goals to turn it into a blog generator: strike.ini file --------------- -Strike should be passed the location of a .ini file or a directory containing a file named strike.ini. This is a text file in Python's configparser format (for now). You can see an example config file in the sample directory. +Strike should be passed the location of a .ini file or a directory containing a file named strike.ini. This is a text file in Python's configparser format (for now). You can see an example config file with all supported options at sample/strike.ini. Markup ------ @@ -36,7 +36,13 @@ It generates <section>s and has specific markup for page titles. Templating ---------- -TBD. Right now, templates should be written in plain HTML. The special marker ${content} will be replaced with all custom page content (also in raw HTML). +TBD. + +Right now, templates are just HTML in a Python f-string. You have access to the following variables: + +{content} : Complete file contents. +{meta['title']} : Filename, with extension dropped. +{meta['date']} : File modification date. Front matter ------------ |