Cecil config generator

.github/workflows/deploy.yml

@@ -0,0 +1,49 @@
+# Based on https://github.com/actions/starter-workflows/blob/main/pages/static.yml
+name: Build static & deploy to GitHub Pages
+
+on:
+  # Runs on pushes targeting specified branch
+  push:
+    branches: ["cecil"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+  # Allows this workflow to be called from other workflows
+  workflow_call:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: shivammathur/setup-php@v2
+      - name: Setup GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build static
+        run: php cecil.phar build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: '_site/'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1 +1,5 @@
 docs
+
+_site/
+.cache*
+.cecil

Makefile

@@ -0,0 +1,12 @@
+all: data/configOptions.json
+
+.PHONY: build
+build:
+	php cecil.phar build
+
+.PHONY: serve
+serve:
+	php cecil.phar serve
+
+data/configOptions.json:
+	php data/fetch.php

README.md

@@ -1,5 +1,28 @@
 # cypht-website
-This is the source of the [cypht.org](https://cypht.org/) website. It's simple static HTML with no
+This is the source of the [cypht.org](https://cypht.org/) website. It's a HTML site statically generated with [cecil](https://cecil.app/), 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.
+```bash
+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
+```bash
+# In project root
+rm data/configOptions.json
+php data/fetch.php  # alt: make
+```

cecil.yml

@@ -0,0 +1,63 @@
+title: 'Cypht Website'
+baseline: 'cypht.org website'
+baseurl: 'https://www.cypht.org/'
+description: 'Cecil-powered static site generation for cypht.org'
+author:
+  name: multiple
+  url: 'https://example.com/'
+image: cecil-card.png
+pages:
+  virtual:
+    - path: contribute-redirect
+      slug: contribute
+      redirect: /contribute/
+      uglyurl: true
+    - path: developers-documentation-redirect
+      slug: developers-documentation
+      redirect: /developers-documentation/
+      uglyurl: true
+    - path: documentation-redirect
+      slug: documentation
+      redirect: /documentation/
+      uglyurl: true
+    - path: email-filters-redirect
+      slug: email-filters
+      redirect: /email-filters/
+      uglyurl: true
+    - path: features-redirect
+      slug: features
+      redirect: /features/
+      uglyurl: true
+    - path: how-to-join-redirect
+      slug: how-to-join
+      redirect: /how-to-join/
+      uglyurl: true
+    - path: install-redirect
+      slug: install
+      redirect: /install/
+      uglyurl: true
+    - path: install-1x-redirect
+      slug: install-1x
+      redirect: /install-1x/
+      uglyurl: true
+    - path: install-2x-redirect
+      slug: install-2x
+      redirect: /install-2x/
+      uglyurl: true
+    - path: license-redirect
+      slug: license
+      redirect: /license/
+      uglyurl: true
+    - path: modules-redirect
+      slug: modules
+      redirect: /modules/
+      uglyurl: true
+    - path: security-redirect
+      slug: security
+      redirect: /security/
+      uglyurl: true
+    - path: tests-redirect
+      slug: tests
+      redirect: /tests/
+      uglyurl: true
+

data/configFiles.json

@@ -0,0 +1,12 @@
+[
+    "app.php",
+    "database.php",
+    "2fa.php",
+    "carddav.php",
+    "dynamic_login.php",
+    "github.php",
+    "ldap.php",
+    "oauth2.php",
+    "recaptcha.php",
+    "wordpress.php"
+]