A static site generator written in POSIX sh

Luna Nieves 5b49808847 Remove unnecessary comments 1 month ago
docs 65143939ac Update docs 3 months ago
man 65143939ac Update docs 3 months ago
scripts 58dd8b80ec Switch to tabs for indentation 3 months ago
template f71daa6ce4 Add 'rel="me"' to Mastodon link 1 month ago
LICENSE b4cbfe4c2c Switch from MIT/Expat to ISC 3 months ago
README.md 41baba303e Update README 3 months ago
boop 5b49808847 Remove unnecessary comments 1 month ago
site-settings 58dd8b80ec Switch to tabs for indentation 3 months ago

README.md

boop

A static site generator written in POSIX sh. Only dependency is discount (a C implementation of Markdown).

Usage: boop [-h] [-v] [-f] [-i] [-b file] [-p file] [-r file]

  -f, --full                Generate entire site based on 'content/'
  -i, --index               Create/update top-level index.html file
  -b, --blog <file>         Create/update blog entry
  -p, --page <file>         Create/update a stand-alone page
  -r, --remove <file>       Remove blog entry
  -h, --help                Print this message and exit
  -v, --version             Output version information and exit

Current progress

  • blog
    • posts and index
    • pagination
    • feed
    • tags/categories
  • gallery
    • posts and index
    • pagination
    • feed
    • content warnings
  • quality-of-life
    • create/edit content via commands
    • page/post drafts
    • initial setup with --init
  • misc
    • man pages
    • default template
    • template documentation

Ultimate goal is to make a static site generator that's comfy, safe for long-term use (no worrying about it breaking on a system update) and is easy to write themes for.

Disclaimer

I'm mainly writing this program for myself as a learning project. This means stuff will change frequently as I learn how to code better and figure out a better user workflow, so the only changelog available is the git log (commits marking version bumps contain a summary of all changes). So do not use this script yet if you don't want to deal with all the breakage, because it is definitely not ready for public use.

Also: Issues and pull requests have been turned off, and the former shall remain off until the whole thing is closer to being finished. For the sake of personal comfort, this will be a solo project from beginning to end.

If you still want to mess with this script, I've converted the man pages into PDFs for easier reading until this whole thing is capable of being installed. Check the docs/ folder.