about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
authorStarfall <us@starfall.systems>2021-10-28 22:33:37 -0500
committerStarfall <us@starfall.systems>2023-12-05 10:00:41 -0600
commitf456510d32bfb4014d75241e42b7d16c599697de (patch)
treeddbf78f0cd548577d391033197028c505439212d /README
parent7806ca6c9c72657dcb6f316656a7e4bd4abff629 (diff)
strike: implement basic key=value front matter
Diffstat (limited to 'README')
-rw-r--r--README5
1 files changed, 2 insertions, 3 deletions
diff --git a/README b/README
index 4a8b50a..441fefd 100644
--- a/README
+++ b/README
@@ -50,8 +50,7 @@ Right now, templates are just HTML in a Python f-string. You can use these varia
 Front matter
 ------------
 
-Current plan:
-* Front matter is indicated by starting a file with a line that contains exactly three dashes ( --- ) and nothing else.
-* Front matter begins on the line after that and will be in Python configparser format.
+* Front matter is indicated by starting a file with a line that contains exactly three dashes and nothing else ("---\n").
 * Front matter is closed by another line that containts exactly three dashes and nothing else.
+* Every line between the opening and closing line should be key=value pairs.
 * Front matter is stored into the 'meta' dict, so you can overwrite meta[title] or meta[date] if you want to.