diff options
| author | Starfall <us@starfall.systems> | 2021-10-22 22:14:41 -0500 |
|---|---|---|
| committer | Starfall <us@starfall.systems> | 2023-12-05 10:00:27 -0600 |
| commit | 5b63c384ef8e100518ff50b9cb023ac07265df35 (patch) | |
| tree | 2fb7c335f6b050e3c2bce2573f37881d62780021 /README | |
| parent | 86b9f8635be129da9b367aec9f4d907e9785cf0e (diff) | |
strike: set goals for config file format
Diffstat (limited to 'README')
| -rw-r--r-- | README | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/README b/README index 454d931..f8aefaa 100644 --- a/README +++ b/README @@ -21,13 +21,25 @@ And some stretch goals to turn it into a blog generator: * Turn the extra page into a flexible component that can be added into any other page * Use different templates on different files -Markup: +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. + +Markup +------ + +TBD. No markup is used at the moment. reStructuredText fulfills most of our desires: https://docutils.sourceforge.io/rst.html It generates <section>s and has specific markup for page titles. -Templating: -Complicated templating isn't necessary, just pre-content and post-content boilerplate for now. -The slight gotcha is that the page title may need updated as well, but we'll cross that bridge if we have to. +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). + +Front matter +------------ -Front matter: None for now. + |