A static site generator for mermaids

Luna Nieves f79ed8e86c Delete old scripts, update README 1 day ago
template 92633a6db1 Reimplement blog index generation, plus tweaks 1 day ago
LICENSE f4e450bbeb Minor fix for License 3 months ago
README.md f79ed8e86c Delete old scripts, update README 1 day ago
boop bf7f36bb79 Remove all references to backup script 1 day ago
site-settings bf7f36bb79 Remove all references to backup script 1 day ago

README.md

boop

A static site generator for mermaids. Written in POSIX sh.

Only dependency is discount (a C implementation of Markdown). However, you can still use any Markdown implementation that:

  • has smartypants and fenced code support (-f pants,fencedcode)
  • can process text without adding HTML tags (-t "text")
  • is invoked with markdown

Usage

boop - A static site generator for mermaids
Usage: boop [--help] [--version] [--full] [--index]
            [--blog <file>] [--page <file>] [--remove <file>]

  -h, --help                Print this message and exit
  -v, --version             Output version information and exit

  -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

TODO

  • basic functionality
    • blog posts and index
    • standalone pages
    • config file
  • blog
    • pagination
    • feed
    • categories
  • gallery
    • posts and index
    • pagination
    • feed
    • content warnings
  • misc
    • proper documentation and sample files
    • template clean-up (for public use)

Disclaimer

I'm mainly writing this program for myself as a learning project. If you find any worth in this script I fully encourage you to fork and modify it to fit your own use case, but I've turned off issues and pull requests for a reason. If you find a bug I personally haven't found yet, I won't be able to help you.

If you're still curious and don't mind getting your hands a bit dirty, check the Getting started page first. It should give you an idea as to how the script works and what it will/won't do.