diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1a69a1c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Maciej Ziaja + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bdf6712 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# 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. + +## Generated site structure + +``` ++------------------------------+ +| Header and navbar | ++------------------------------+ +| | +| | +| Body written in Markdown | +| | +| | ++------------------------------+ +| | +| List of posts | +| | ++------------------------------+ +| Footer | ++------------------------------+ +``` + +## Jump start + +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. +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. +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. +7. Publish your blog. + +## Features and non-features + +* 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. + +## Help +``` +./ssb -h +Usage: ./ssb [-d|-g|-h|-r] [-e HEADER_PATH] [-f FOOTER_PATH] [-m MD_RENDERER] + [-o OUTPUT_DIR] [-p POSTS_DIR] +```