Release of version 1.0 (a very stable release) is planned for May 2019.
As of now, all documented features work well, but I have not done extensive testing. I use it for my personal website: wrycode.com.
To build from source, install the dependencies via
Quicklisp, and run
Support for Windows and macOS is planned, but I have not tested on
either platform. The source code is already cross-platform (in
theory), so if you want to test it you can
:betterssg) and then use
(betterssg:main) to build your site instead
of running the executable.
There are currently no command-line arguments; all configuration is
done in the file
To view a preview of the website, I recommend using Python's built-in HTTP server. From the shell:
$ python -m http.server 8080 --directory website/
Inspect the files in the folders
layout/default/. The content folder stores the markdown files
that betterssg will process into finished HTML pages. The layout
that makes up each finished webpage.
I recommend copying
layout/default/ into two
new folders named after your website (like
layout/my-website/). Make sure to change the variables
:layout-folder in the
The name of each markdown file in the content folder represents the
title of the webpage.
example-title.md will become
TITLE. To group pages under a generated blog-style page, simply copy
them to a directory named after the page (e.g.
blog/). To date a
page, prefix the filename with ten digits representing the date
Ergo, all metadata is stored using the filesystem.
The top-level file
home.md will become the homepage of the website.
media/ is a separate folder that will get copied into
when betterssg is run. It can include files of any type, including HTML.
Currently, the layout folder is very simple. The file
is the template for each generated webpage. It is a normal HTML file
with four optional variables:
head.htmlfile (which can sometimes get quite large)
betterssg is opinionated. Simplicity is a priority. Want tags, complex user-defined taxonomies, a domain-specific language, thousands of themes, and a program that calls itself an engine? Use Hugo. Want to just make your website, already? Use betterssg.
--serverargument for running and refreshing a local webserver
<pre>are not working correctly