This program can be used to generate static websites from Markdown files. If you don't know how to use Markdown I suggest reading the Markdown Guide!
After cloning, compiling and adding the executable to the path variable you can get stared by creating your first SSG project.
Create a new directory first and initialize it:
mkdir <project name>
cd <project name>
ssg init
Some files and directories are created for you, you can already generate the
initial project using ssg
. All the Markdown source files live in the src
directory and the template file is at tpl/template.html
. The generated website
will end up in the out
directory.
The following options are available when generating your static site:
--clean: Remove leftover files for which the source no longer exists.
--ignore-unchanged: Do not update output if the source file is not updated since generation.
--include-source: Include the Markdown source file in the output.
I currently use SSG to generate my own static site.