cypht-website

This is the source of the cypht.org website. It's a HTML site statically generated with cecil, with no non-vendor JavaScript. Cypht (pronounced "sift") is like a news reader, but for E-mail. Cypht does not replace your existing accounts - it combines them into one. And it's also a news reader.

As of 2024-02-14, www.cypht.org updates from https://github.com/cypht-org/cypht-website/ on a daily cron job.

How-to

Build locally

This requires git & PHP 8 to be installed.

git clone https://github.com/cypht-org/cypht-website.git
cd cypht-website

# Build to _site/
php cecil.phar build  # alt: make build

# Serve/develop on localhost:8000
php cecil.phar serve  # alt: make serve

Nix users can use nix-shell -p php81 gnumake git to get all requirements to build.

Update config generator options (data/configOptions.json)

# In project root
rm data/configOptions.json
php data/fetch.php  # alt: make

Explanation

cypht-config-generator-generator

The config generator was originally a project that started out at as a Node.JS-generated static site to help configure Cypht, to have a properly interfaced & mostly self-updating interface to configure your Cypht instance. It downloads, caches & parses the Cypht config files into a static site that outputs a .env. That project has been translated into the PHP-based Cecil generator, into the files below.

• static/config-generator.js: client-side JavaScript
• pages/config-generator.md: defines HTML page generation at /config-generator/
• layouts/partials/config-generator.html.twig: generates the config generator from configOptions.json
• data/
  • fetch.php: generates data/configOptions.json
  • configFiles.json: hand-written list of files to check from the Cypht repository for config options. Used by fetch.php
  • configOptions.json: contains all config options in a format useable in config-generator.html.twig. Generated by # How-to: Update config generator options