about summary refs log tree commit diff
path: root/README
blob: b6f2c67d94da2d6e3253f8f7b6799c76911ccdd4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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.