toaster is a static website generator that takes in a folder of markdown files and produces a folder of HTML files, ready to be browsed or uploaded to a web server. This website was generated with toaster.
Installation
Source code can be found at code.benbridle.com/toaster.
The latest release is available as pre-built executables for Windows or Linux:
Build from source
To build toaster from source, first install the Rust compiler from www.rust-lang.org/tools/install, and then run cargo build --release inside the toaster source code directory.
The compiled binary will be created at ./target/release/toaster.
Usage
To generate an HTML website using Toaster, run the following command from the terminal:
toaster <source> <destination> --html
<source> is the path to your folder of markdown files, and <destination> is the path to a folder where the generated website will be placed.
See the user manual page for the full user manual.
If you don’t like reading manuals, you can download a small example website from example-website.zip and figure things out from there. To see the markdown for any page on this website, add a .md extension to the page URL and reload.
Background
This website was originally hosted under a public web server community called breadpunk.club (now defunct), where every user had a bread-related username. My username was toast, and this website was hosted at the URL breadpunk.club/~toast.
When it came to writing a program that would turn my markdown files into HTML files, I named it toaster, because it was a machine that turned raw ingredients (bread, I guess) into toast.
Support
If you have any questions about Toaster, send an email to support@derelict.engineering for assistance and advice.