An incredibly small, no-configuration static site generator shell script.

Horsemans b8bdbc1854 Initial commit. 2 years ago
.gitignore b8bdbc1854 Initial commit. 1 week ago
LICENSE b8bdbc1854 Initial commit. 1 week ago
README.md b8bdbc1854 Initial commit. 1 week ago
foot.html.tmpl b8bdbc1854 Initial commit. 1 week ago
head.html.tmpl b8bdbc1854 Initial commit. 1 week ago
make.sh b8bdbc1854 Initial commit. 1 week ago
next.sh b8bdbc1854 Initial commit. 1 week ago
rsync-excludes.txt b8bdbc1854 Initial commit. 1 week ago
sync.sh b8bdbc1854 Initial commit. 1 week ago

README.md

Piecemeal is two tiny shell scripts that allow you to quickly create a microblog.

There are no settings, and no configuration. The layout of URLs or the home page cannot be changed.

The focus is to get you to write something with as little thought as possible.

Entries

  1. Entries have no title. The first sentence of each entry is truncated for display on the home page.

  2. Entries have no metadata. Only the file creation date is respected, which is used to roughly group entries together on the home page.

  3. Entries are Markdown files.

  4. Entry files are created using next.sh. This will automatically number your next entry, create the Markdown file in the appropriate place, and open $EDITOR.

File Layout

  1. The URL layout is fixed. Entries are named index.md in individual folders with monotonically increasing integral names. The output file, index.html, is placed in the same directory.

  2. Output is generated using make.sh. It will process each Markdown file, and generate the index page and all output files.

  3. Piecemeal expects CommonMark to be installed, and cmark to be in your $PATH. To install CommonMark, contact your system administrator.

  4. Header and footer templates are applied to each output file.

  5. Templates are placed in head.html.tmpl and foot.html.tmpl. Sample templates are provided.

Publishing

  1. An rsync template (and configuration file) is provided for uploading the output to a server via SSH.