sarah
/
pseudorandom
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Maciej Ziaja 2020-02-26 00:29:46 +01:00 committed by GitHub
parent 75ad511dcf
commit b0a2853459
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

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