SSSG is a layout-based static site generator built for parallelism and minimalism while being flexible and feature-full. Think of it as a layer of glue, which glues layers of papers into 3D models. It's perfect for simple personal sites that adheres to the KISS Principle while being able to follow the Suckless Philosophy and get rid of Dependency Hell.
It gives you the choice to be in control of your own site. But in return, you need to give it love and time like a wise man once spoken: “先苦后甜”.
Usage: make -j4 (or any number you like)
+--------------------+ +--------------------+ +--------------------+
| layouts/main.dhtml | | layouts/post.dhtml | | post/_www/config |
+--------------------+ +--------------------+ +--------------------+
|<!DOCTYPE HTML> | |#-# vim:ft=html: | |LAYOUT=layouts/post+|
| | |LAYOUT=layouts/main+| |DATE=$(date $forig) |
|<html> | |F=$forig | |T=$(head -n $forig) |
|<head> | |#-# | +---------+----------+
| <title>${T}</titl+| | | |
|</head> | |${F} | +---------+----------+
|<body> | |==== | | post/test.md |
| ${CONTENT} <------ |${CONTENT} <------ +--------------------+
|</body> | | | |- Hello World! |
|</html> | |Created by ${DATE} | |- cmark-powered |
+--------------------+ +--------------------+ +------------------- +
^
--- rm -rf $(TARG)/ |
+----------/ |
| clean | ./html.sh post/test.md > $(TARG)/post/test.html
+==========+-----+ /
| Makefile | all + ---- ./html.sh index.html > $(TARG)/index.html
+==========+-----+ \
| ------- ./atom.sh post/ > $(TARG)/%/atom.xml
+------+--+
| check | validate online -> ./check.sh $(TARG)
+---------+
| gzip | -> gzip -9k (all compress-able files)
+---------+
The installation is simple, just make this your site:
git clone https://github.com/pickfire/sssg --depth 1
rm -rf sssg/.git-
The
_www/configfound at the previous/current directory of the input file will be sourced, bash script and variables are optional. -
Add bash functions/variables in between
#-#lines at the beginning of the code, the second#-#must not have trailing characters. (optional) -
In between those lines of code, add
LAYOUT=path/layout.dhtmlto paste the current content intolayout.dhtml's${CONTENT}. -
Use
${VAR}(must be uppercase) in files to substitute it to the variable, unused variables (line) will be deleted when generation is completed.
- cmark: https://github.com/jgm/cmark (A commonmark implementation in C)
- mksh: https://www.mirbsd.org/mksh.htm (For a faster shell)
- bash: http://www.gnu.org/software/bash/bash.html
- GNU coreutils: http://www.gnu.org/software/coreutils
- GNU sed: http://www.gnu.org/software/sed
- GNU grep: http://www.gnu.org/software/grep/grep.html
atom.sh- Find Markdown files and generate an Atom feed from ithtml.sh- Output HTML content with a file as inputcheck.sh- Find HTML/CSS/XML files and verify it online
- Personal help -> Email [email protected]
- Issue Tracker
- Pull Requests
- Source code (Mirror)
- Paper Color Theme as a nice color scheme
- Statikiss framework project which is another bash static site generator based on suckless
- Suckless philosophy which always focus to keep the code minimal
- YAML frontmatter that enhance the features of a site generator
- Statikiss framework project which is another bash static site generator inspired by suckless philosophy
- Pickfire's site (Mirror)
- Add your site here