logo for basementcommunity

basement
community

search

wall of shame

software Give me feedback on my static-site generator

deleted_user

joined some time ago

avatar

deleted_user

joined some time ago

Hello everyone,

A while ago, I made this. It's a simple static-site generator, written in Python. When I was creating it, I had a few design goals:

  • Get it to run on most major platforms

  • Create something small enough that it's easy to look through all the code

  • Focus on having less features, but create something that works well.

The SSG works by doing the following, for every page that exists:

  • Save 'top' section into corresponding output .html file

  • Save content (if markdown, then it uses a library to render the markdown to html) into the output file

  • Save 'bottom' section into the corresponding output .html file

The 'top' section refers to a user-defined bit of text that would be pasted into the very top of every single page. Normally, I'd put my meta tags, navigation bar, etc all in there.

The 'bottom' section is similar, except it's pasted into the very bottom of every single page. Normally, I'd put my footer, and closing tags in there.

I want to get some feedback on what I've made. Is there something I should add? Remove? etc.

Looking forward to hearing from you all.

posted 4/23/2023, 11:03 pm

joined apr 10, 2023

avatar

im sorry

joined apr 10, 2023

i think part of the main draw of a md -> static site generator is being able to automatically handle putting together things like next/previous post buttons for blog type content, or general organizing of links for navigating around since the generator will know what url everything eventually has. generally id only look towards a SSG when i know im going to want a lot of pages and not want to bother remebering to update links or manage a list on the homepage.

something else that may be nice is being able to setup extra html/js/css for individual pages, in case those need content or interactivity that is distinct from any others. for instance if in content/* i have myPage.md the generator could look for and automatically link myPage.js/.css if those exist, but only on that page. you could also do that on a per-folder basis, have it look for something like __common.js

posted 4/27/2023, 6:52 am

software Give me feedback on my static-site generator