eklausme/saaze-nukeklaus

A blog-theme for nukeKlaus.net

v1.1 2024-04-09 18:49 UTC

Requires

• eklausme/saaze: >=1.24

MIT

• Elmar Klausmeier

README

Example theme for Simplified Saaze

Here is an example theme, called nukeklaus, modeled after nukeKlaus.net. Some characteristics:

1. Responsive design with three, two, or only one column
2. Categories and tags
3. Hero image
4. Blog
5. RSS feed + sitemap
6. Search functionality, if you have PHP on the web-server

This nukeklaus example will generate a full website for nukeKlaus.net.

Using Simplified Saaze will further provide MathJax, YouTube, Twitter, CodePen, image galleries, and all the other goodies.

Simplified Saaze

Simplified Saaze is a fast, all-inclusive, flat-file CMS for simple websites and blogs.

Static site builders are fast but normally have a steep learning curve and require lots of tooling to make them work. We believe building a personal site should be stupidly simple. That's why Simplified Saaze is built on the following principles.

• Easy to run - All you need is PHP8, a C compiler, and Composer
• Easy to host - Serve dynamically or statically
• Easy to edit - Edit content using simple Markdown files
• Easy to theme - Templates use plain PHP/HTML
• Fast and secure - No database = less moving parts + more speed
• Simple to understand - Everything is a collection of entries

Read Simplified Saaze for installation and usage.

Usage

Run

composer create-project eklausme/saaze-nukeklaus

This will copy the files of this Git repository, it will also install Simplified Saaze. To run Simplified Saaze you still need to compile one C program, install one PECL (PHP extension), and configure one PHP file. This is something you have to do only once.

1. Demo. You can view the theme in action here: nukeklaus. The content is taken by downloading via curl and then converting via blognukeklaus2md.

The source code for the nukeklaus theme is here: eklausme/saaze-nukeklaus. It can be installed with Composer:

composer create-project eklausme/saaze-nukeklaus

This will install the theme and the static site generator in one step. You still need to follow the steps in Installation, i.e.,

1. make yaml extension available for php
2. compile php_md4c_toHtml.c

Once everything is installed switch to the directory and run

time php saaze -mrtb /tmp/build

The time is only to show you how quick it runs. Runtime on AMD Ryzen 7 5700G is 0.1 seconds for 174 blog posts. And for this only a single core is used. The -b /tmp/build is used to generate the static HTML file in /tmp, which happens to be a RAM disk on Arch Linux. Any other directory will do.

Shell script blognukeklausDeploy provides an example deployment-script.

2. Conversion. In case you want to replicate the conversion from the original nukeKlaus.net to Simplified Saaze you will proceed as follows:

(1) Download all posts via curl:

blognukeklauscurl wp-sitemap-posts-post-1.xml

(2) Convert from HTML to Markdown:

for i in *.html; do blognukeklaus2md $i > /tmp/T/`basename $i .html`.md; done

(3) Create year index:

for i in `seq 2013 2022`; do blogdate -gp../ -y$i $i*.md > $i/index.md; done

Credits

Simplified Saaze was created by Elmar Klausmeier.

Saaze was created by Gilbert Pellegrom from Dev7studios. Released under the MIT license.