jbauer
/
sbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial commit

This commit is contained in:
Jake Bauer 2021-08-25 09:47:17 -04:00
commit e0db2ae481
2 changed files with 57 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
LICENSE Normal file
View File

@ -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.

42
README.md Normal file
View File

@ -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.