eklausme/saaze-jpilot

An example theme and content using the Simplified Saaze static site generator

v1.2 2024-04-09 18:27 UTC

This package is auto-updated.

Last update: 2024-11-04 11:59:23 UTC


README

Latest Stable Version License

Example theme for Simplified Saaze

This J-Pilot example will generate a full website for the J-Pilot desktop organizer software. It features:

  • a top-menu with sub-menus
  • documentation pages in English and German
  • a blog
  • bottom shows various social media icons: e-mail, LinkedIn, GitHub, RSS
  • the theme has some responsive elements

It is a modified version of the original website found here: J-Pilot.

Building this website lasts 0.02 seconds on a AMD Ryzen 7 5700G.

You can see the result here: J-Pilot.

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.

Installation

Run

composer create-project eklausme/saaze-jpilot

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.

Deployment for static site

Once you have run php saaze and the static files have been generated in the build directory, the following directories and files need to be copied to your web root:

  1. build/blog
  2. build/doc
  3. build/index.html

The following directories and files only need to be copied if they have been changed:

  1. public/img
  2. pkg (contains only example files)
  3. jpilot.css
  4. index.html

Credits

Simplified Saaze was created by Elmar Klausmeier.

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

J-Pilot web-site from Judd Montgomery.