diff options
| author | Starfall <us@starfall.systems> | 2021-10-21 12:11:23 -0500 |
|---|---|---|
| committer | Starfall <us@starfall.systems> | 2023-12-05 10:00:03 -0600 |
| commit | e1cefc4d17cd0f1983e7f5106f4003fb6b2a9591 (patch) | |
| tree | 0e5469900e97301711f6c5e510974deff1715b3b | |
| parent | cd5699fc227d13896ea88239fd8fe1e8396cca20 (diff) | |
strike: Lay out initial design goals
| -rw-r--r-- | README | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README b/README new file mode 100644 index 0000000..b6f2c67 --- /dev/null +++ b/README @@ -0,0 +1,27 @@ + _____ __ _ __ + / ___// /______(_) /_____ + \__ \/ __/ ___/ / //_/ _ \ + ___/ / /_/ / / / ,< / __/ +/____/\__/_/ /_/_/|_|\___/ +============================ + +A static site generator that does exactly what we need it to and no more. + +(c) 2021 Starfall <starfall.systems>, all rights reserved until I decide it's in a good enough state for others to use. + +Strike has simple goals: +1. Read markup files from source folder +2. Convert to HTML +3. Add boilerplate (head, header, footer, etc) +4. Save to output folder + +One slight gotcha: + * May need to fill out several different locations in the template (e.g. page title and page content) + +And some stretch goals to turn it into a blog generator: + * Create an extra page listing all generated pages in order of creation date (newest first) + * Add links to next & previous generated pages + * Turn the extra page into a flexible component that can be added into any other page + +reStructuredText fulfills most of our desires for markup: https://docutils.sourceforge.io/rst.html +It generates <section>s and has specific markup for page titles. |