sbs

A Simple Blogging System.
git clone https://git.sr.ht/~jbauer/sbs
Log | Files | Refs | README | LICENSE

commit e0db2ae481844e722c69e68f34ad1889cb3bd2b9
Author: Jake Bauer <jbauer@paritybit.ca>
Date:   Wed, 25 Aug 2021 09:47:17 -0400

Initial commit

Diffstat:
ALICENSE | 15+++++++++++++++
AREADME.md | 42++++++++++++++++++++++++++++++++++++++++++
2 files changed, 57 insertions(+), 0 deletions(-)

diff --git a/LICENSE b/LICENSE @@ -0,0 +1,15 @@ +ISC License + +Copyright 2021 Jake Bauer <jbauer@paritybit.ca> + +Permission to use, copy, modify, and/or distribute this software for any purpose +with or without fee is hereby granted, provided that the above copyright notice +and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS +OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER +TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF +THIS SOFTWARE. diff --git a/README.md b/README.md @@ -0,0 +1,42 @@ +# Simple Blogging System (working title) + +A blogging system designed to be simpler to use than existing solutions such as +Hugo and Jekyll. + +## Goals + +An outline of what I intend to accomplish with this project: + +### Design + +Simple and easy to use. Instructions for use should not be very long, and a +user familiar with blogging systems should be able to understand this without +much effort. + +Documentation should be simple and easy to understand for non-technical users. + +Creation of a few CSS styles for simple blog layouts, but otherwise no big +complicated themes, no JavaScript, and no hacky HTML generation. + +Minimal external dependencies: + +* lowdown for compiling markdown to HTML +* optipng for optimizing PNGs +* ImageMagick for optimizing JPGs, resizing images + +### Functionality + +Does exactly what a blog needs: + +* Basic metadata for each post +* Atom feed creation +* Optional table of contents (three levels) +* Support for static pages +* Content written in markdown +* Basic website styling -> One CSS file + +And some extra quality-of-life features: + +* Image thumbnail creation +* Parallel page compilation +* Integration with Mastodon-API for posting when a new blog post is published.