Update README

This commit is contained in:
Jake Bauer 2022-08-17 19:59:02 -04:00
parent 95b4d4a51c
commit 70a244abd7
1 changed files with 20 additions and 20 deletions

View File

@ -3,30 +3,30 @@
A simple static site generator designed to be simpler to use than existing
solutions such as Hugo and Jekyll.
# Installation
This project is actively maintained.
## Features
* Create static HTML pages from Markdown and Gemini documents with minimal
header and footer "templates"
* MultiMarkdown metadata support
* Easy creation of an Atom feed containing the content of all posts
* Basic website styling through one CSS file (by default)
* Easy method to deploy generated files
* Simple configuration file
## Installation
Place the sbs program and the sbs.1 manpage in the appropriate paths for your
operating system. `/usr/local/bin/` and `/usr/local/man/man1/` are likely
respective paths.
operating system. `/usr/local/bin/` and `/usr/local/man/man1/` are the likely
paths, respectively.
# Usage
## Usage
Please refer to the manpage for usage and other information.
## What Can It Do?
## Contributing
After trying out Hugo and other popular static site generators, I found that
even the solutions which call themselves simple are too complicated for what I
need for my websites. I also found that I need a greater degree of control
over the generated output without having to spend hours creating or fiddling
with templates. I wanted to make something that does the bare minimum of what I
need out of a static site generator/blogging system while making it as painless
as possible to write content for my site.
sbs therefore has the following features:
* Create static HTML pages from Markdown documents with minimal "templates"
* Metadata support (MultiMarkdown)
* Easy creation of an Atom feed containing the content of all posts
* Basic website styling through one CSS file
* Simple configuration file
Send any patches or inquiries to
[~jbauer/public-inbox@lists.sr.ht](mailto:~jbauer/public-inbox@lists.sr.ht) or
to [jbauer@paritybit.ca](mailto:jbauer@paritybit.ca).