diff --git a/README.md b/README.md index bdf6712..08a48c3 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ # Ssb – simple static blogger Ssb is a suckless static site generator and blogging anti-framework. -It is useful for creating very simplistic blogs based on markdown writing. -If you're looking for a blogging tool that takes nearly no time to setup and -learn to use and want to just start writing with markdown ssb is perfect for -the task. +It is useful for creating very simplistic blogs based on Markdown writing. +If you're looking for a blogging tool that takes nearly no time to set up +and just want to start writing with Markdown, then ssb is a perfect script +for the task. + +Ssb is heavily inspired and based on +[this](https://benedicthenshaw.com/static_site.html) +post. ## Generated site structure @@ -30,28 +34,28 @@ the task. 1. A POSIX compliant shell and your favourite markdown renderer (pandoc by default) are required. -2. Download ssb and place it in your `PATH` or inside your blog directory. +2. Download `ssb` and place it in your `PATH` or inside your blog directory. 3. Run `ssb -g` to generate html and css templates. Adjust the header and the footer to your liking, you can customize the stylesheet, use a css theme, - or your favourite style for markdown. -4. Write your index.md page and posts in `posts` directory. + or your favourite style for Markdown. +4. Write your `index.md` page and posts in `posts` directory. 5. Run `ssb index.md` to generate `html` files. Ssb will append header, list of posts and footer to each file. 6. The timestamps near posts titles are generated from modification dates of - markdown files. - If you wish to change them use `touch -d` command on them. + Markdown files. + If you wish to change them use the `touch` command. 7. Publish your blog. ## Features and non-features -* Ssb is a single POSIX compliant script that requires only a markdown renderer +* Ssb is a single POSIX compliant script that requires only a Markdown renderer to create blogs. * It is not a *real framework*, just a hackable script to automate blogging and save your time. * No tags, no artifacts, no javascript, no learning, no lengthy setup. * If you want a simple and effortless blogging engine ssb is perfect for you, - whether you want something more features you can hack it, or use something - more advanced like Jekyll or Hugo. + whether you want something with more features you can hack it, or use + frameworks like Jekyll or Hugo. ## Help ```