Quick Site Generator 2 is a static website generator inspired by Nikola and written using Zsh

html script shell shell-script static-site-generator zsh

Go to file

Stig-Ørjan Smelror 1c2e480232 Update README.md		2024-02-02 13:04:25 +01:00
include/common	Add theme example and minor addition to config	2024-01-29 14:33:59 +01:00
themes/minimal	Remove Matomo section from theme templates	2024-01-29 14:36:31 +01:00
config	Lots of things.	2024-01-31 14:57:34 +01:00
LICENSE	Initial commit	2024-01-28 18:13:25 +01:00
qsgen2	Disable debugging	2024-02-02 12:36:11 +01:00
README.md	Update README.md	2024-02-02 13:04:25 +01:00

README.md

Quick Site Generator 2

Quick Site Generator 2 is a static website generator inspired by Nikola and written using Zsh.

qsgen2 is capable of creating static HTML pages using the native _html engine (that I'll describe in detail later) or by writing your pages and blogs in Markdown. It uses Pandoc, mostly because it's the most compete tool for the job. Not all Linux distributions have it, so you can just download the binaries and place them where it suits you the best.

You cannot mix native and Markdown when creating your project.

Configuration

You first have to configure your site and this is done in the file config.

Themes

qsgen uses templates that reside in $project_dir/themes/<theme name>. The theme consists of 4 files:

blogs.tpl
pages.tpl
blog_index.tpl
blog_list.tpl

Blogs

The file blogs.tpl is used to create the blog posts that will reside in $www_root/blogs/year/mon/date/title-of-blog-post.html. qsgen2 will list all the files in blog/*.blog and do its magic before the word/tag BODY in the blogs.tpl file is replaced with the HTML formatted content and then the file will be written to disk.

Other tags/words that are replaced are:

BLOGTITLE
CALADAY
CALNDAY
CALMONTH
CALYEAR
INGRESS

Then the footer of the document is updated with today's date and the name and version of the script.

The themes engine is not 100% complete because there still are some static text that could or should be replaced. It is, however, quite easy.

Blog Index

There is an option in the file config if you want to show the blog on the front page or not. If set to false, it will write a file in $www_root/blog/index.html that contains, in reverse order, the blogs written.

To do this it uses the file blog_list.tpl as a template for how to format this list and then it inserts this into the file blog_index.tpl which then is written to disk.