sbs

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

commit ca13e29f72e4da705fd233feba893cba3740fe18
parent 261911b45fff9ae3f65d4230963768602aea8ca9
Author: Jake Bauer <jbauer@paritybit.ca>
Date:   Mon, 14 Feb 2022 22:53:35 -0500

Update README

Diffstat:
MREADME.md | 15+++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md @@ -1,23 +1,26 @@ -# Simple Blogging System (working title) +# SBS - Simple Blogging System A simple static site generator designed to be simpler to use than existing solutions such as Hugo and Jekyll. # Usage +`sbs [new [post|site]] file` + 1. Create a new site with `sbs new site <name>` where `<name>` is the name of the directory under which your sites files will be; 2. Enter the newly-created directory and alter alter `config.ini`, - `templates/header.html`, `templates/footer.html`, and `static/style.css`; + `templates/header.html`, `templates/footer.html`, and `static/style.css` to + fit your site; 3. Create a new page with `sbs new page <location>`. It will be placed into the `content/` directory at the location specified (so if you specify - `blog/new-post` , the `blog/` directory should exist); -4. Run `sbs <files>` to build particular files. The output will appear in - `static/`. + `blog/new-post` , the `blog/` directory should already exist); +4. Run `sbs <files>` to build particular files. The output will appear under + `static/`; 5. Use a utility like `rsync` to copy the contents of the `static/` directory to your webserver. -A complete example: +Here's a quick example: ``` $ sbs new site example.com