sbs

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

README.md (1044B)


      1 # sbs - Simple Blogging System
      2 
      3 A simple static site generator designed to be simpler to use than existing
      4 solutions such as Hugo and Jekyll.
      5 
      6 This project is actively maintained.
      7 
      8 ## Features
      9 
     10 * Create static HTML pages from Markdown documents with minimal
     11   header and footer "templates"
     12 * MultiMarkdown metadata support
     13 * Easy creation of an Atom feed containing the content of all posts
     14 * Basic website styling through one CSS file by default
     15 * Easy method to deploy generated files
     16 * Simple configuration file
     17 
     18 ## Installation
     19 
     20 First, ensure that [lowdown](https://kristaps.bsd.lv/lowdown/) is installed.
     21 
     22 Place the sbs program and the sbs.1 manpage in the appropriate paths for your
     23 operating system. `/usr/local/bin/` and `/usr/local/man/man1/` are the likely
     24 paths, respectively.
     25 
     26 ## Usage
     27 
     28 Please refer to the manpage for usage and other information.
     29 
     30 ## Contributing
     31 
     32 Send any patches or inquiries to
     33 [~jbauer/public-inbox@lists.sr.ht](mailto:~jbauer/public-inbox@lists.sr.ht) or
     34 to [jbauer@paritybit.ca](mailto:jbauer@paritybit.ca).