Home

Quick Start

To get slimeblogger, either clone this repo or download a zip here.

If you wish to see this tool in action, you can generate a sample blog!
Open your console to the slimeblogger/build directory and execute the generatePage.py file:

python generatePages.py

All your blog files will be generated in the provided public_html file. Upload them to your website, Neocities, wherever!

⚠️ If you receive an error about missing required libraries, see the Requirements section below.

Requirements

Make sure you have the latest version of Python.

Open your console to the slimeblogger/build directory and run this command to install requirements:

pip install -r requirements.txt

⚠️ If you encounter issues with the tomllib library, please ensure you have Python 3.11 or greater. This script is not compatible with old versions of Python.

Config

Open the slimeblogger/build/config.toml file and change the defaults. Below is the setup I would use for my own blog at tilde.town/~slimelia:

# The root URL for your blog - this is needed for Atom feeds.
# Doesn't actually need to be the root of your entire website,
# just the URL of the blog index page.
#
# If field is empty, Atom feed will not be generated.

rootURL = "https://tilde.town/~slimelia"

## Title of blog as it will appear in Atom feed.
title = "DIGITAL DEBUTANTE"

Writing Posts

Posts are in Markdown format, saved as .md files in slimeblogger/build/posts. The first line of your Markdown document must appear as follows:

@title Title Goes Here @author author_name_here @date yyyy-mm-ddThh:mm

See the provided sample posts for further guidance.

Dates

The date string can either be in the format of yyyy-mm-dd or yyyy-mm-ddThh:mm. For example, both 2024-05-12 and 2024-05-12T19:45 are valid. Time must be in 24hr format. The time is not displayed in posts, but is used to sort posts from the same date & for Atom feed fields. If no time is given, the time in the Atom feed will be 00:00.

Editing Header

To edit the links in the navbar and the default Blog Header Here title, edit the HTML in the slimeblogger/build/templates/site.mustache file.

Custom CSS

The default stylesheet is found in slimeblogger/public_html. Change this however you wish.