Sarah Jamie Lewis 736954c505 | ||
---|---|---|
.idea | ||
katex | ||
posts | ||
woff2 | ||
LICENSE | ||
README.md | ||
a_closer_look_at_fuzzy_threshold_psi.html | ||
a_closer_look_at_fuzzy_threshold_psi.png | ||
feed.xml | ||
footer.html | ||
ftpsi-parameters.html | ||
ftpsi-parameters.png | ||
header.html | ||
index.html | ||
index.md | ||
obfuscated_apples.html | ||
obfuscated_apples.png | ||
ssb | ||
styles.css |
README.md
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 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 post.
Generated site structure
+------------------------------+
| Header and navbar |
+------------------------------+
| |
| |
| Body written in Markdown |
| |
| |
+------------------------------+
| |
| List of posts |
| |
+------------------------------+
| Footer |
+------------------------------+
Jump start
- A POSIX compliant shell and your favourite markdown renderer (pandoc by default) are required.
- Download
ssb
and place it in yourPATH
or inside your blog directory. - 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. - Write your
index.md
page and posts inposts
directory. - Run
ssb index.md
to generatehtml
files. Ssb will append header, list of posts and footer to each file. - The timestamps near posts titles are generated from modification dates of
Markdown files.
If you wish to change them use the
touch
command. - 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 with more features you can hack it, or use frameworks 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]
Stylesheets for theming can be found here.