Migration to Zensical

.github/workflows/publish.yml

@@ -3,61 +3,36 @@ on:
   push:
     branches:
       - master
-env:
-  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.MKDOCS_GIT_COMMITTERS_APIKEY }}
+permissions:
+  contents: read
+  pages: write
+  id-token: write
 jobs:
   deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout latest push
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
+      - uses: actions/checkout@v5
 
-      - name: Setup Python env
-        uses: actions/setup-python@v5
-        with:
-          python-version: 3.9.16
+      - uses: actions/configure-pages@v5
 
-      - name: Set up build cache
-        uses: actions/cache/restore@v4
+      - uses: actions/setup-python@v5
         with:
-          key: docs-${{ hashfiles('.cache/**') }}
-          path: .cache
-          restore-keys: |
-            docs-
-
-      - name: Setup Github
-        run: |
-          git config --local user.email "action@github.com"
-          git config --local user.name "GitHub Action"
-          git pull
-          git checkout master
+          python-version: "3.11"
 
-      - name: Install Dependencies
-        run: |
-          make install-python-packages
-          sudo apt-get install pngquant
+      - name: Install Zensical
+        run: make install
 
-      - name: Install MkDocs Insiders
-        if: github.event.repository.fork == false
-        env:
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
-        run: pip install --upgrade git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.6.14-insiders-4.53.16
+      - name: Build site
+        run: zensical build --clean
 
-      - name: Deploy Release Version
-        run: |
-          mkdocs gh-deploy --force --config-file mkdocs-insiders.yml
-
-      - name: Deploy to Server
-        run: |
-          git checkout gh-pages
-          git remote set-url --push origin https://actions:$GITHUB_TOKEN@github.com/ExpressLRS/Docs
-          git push -f origin gh-pages
-
-      - name: Save build cache
-        uses: actions/cache/save@v4
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v4
         with:
-          key: docs-${{ hashfiles('.cache/**') }}
-          path: .cache
+          path: site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.python-version

@@ -0,0 +1 @@
+3.11

Dockerfile

@@ -1,16 +1,4 @@
-FROM squidfunk/mkdocs-material:9.6.19
-RUN apk add \
-    build-base \
-    libxml2-dev \
-    libxslt \
-    libxslt-dev \
-    dumb-init
+FROM zensical/zensical:0.0.32
 
-WORKDIR /docs
-COPY ./Makefile ./Makefile
-RUN make install-python-packages
-
-EXPOSE 8000
-
-ENTRYPOINT ["dumb-init"]
-CMD ["mkdocs", "serve", "--livereload", "--dev-addr=0.0.0.0:8000"]
+# WORKDIR, EXPOSE 8000, ENTRYPOINT and the default
+# `serve --dev-addr=0.0.0.0:8000` CMD are inherited from the base image.

Makefile

@@ -1,19 +1,21 @@
-.PHONY: install-python-packages
-install-python-packages:
-	pip install \
-      "mkdocs-minify-plugin==0.8.0" \
-      "mkdocs-redirects==1.2.2" \
-      "mkdocs-static-i18n==1.3.0" \
-      "mkdocs-git-committers-plugin-2==2.5.0" \
-      "mkdocs-git-revision-date-localized-plugin==1.4.5" \
-      "cairosvg==2.8.1" \
-      "jinja2==3.1.6"
+# Host-only convenience wrappers around `docker compose`.
+# CI invokes `docker compose` directly and never calls `make`.
 
+.PHONY: install build run serve site shell
+
+install:
+	pip install "zensical==0.0.32"
 
-.PHONY: build
 build:
 	docker compose build
 
-.PHONY: run
-run:
+run: serve
+
+serve:
 	docker compose up
+
+site:
+	docker compose run --rm docs build --clean
+
+shell:
+	docker compose run --rm --entrypoint sh docs

docker-compose.yml

@@ -0,0 +1,8 @@
+services:
+  docs:
+    build: .
+    image: expresslrs-docs
+    ports:
+      - "8000:8000"
+    volumes:
+      - .:/docs

docs/index.md

@@ -1,4 +1,21 @@
 ---
-template: home.html
 title: High Performance Open Source Radio Control Link
 ---
+
+# ExpressLRS
+
+ExpressLRS is a fully open radio control link built for maximum range,
+speed, and data throughput. Wide hardware support across both 900 MHz and
+2.4 GHz frequencies.
+
+<!--
+TODO (Zensical migration): the rich homepage from overrides/home.html
+(hero, feature grid, recent blog posts via overrides/hooks/blog_posts.py)
+has not yet been ported to Zensical's template system. Until that lands,
+this page is a plain placeholder.
+-->
+
+- [Getting Started](quick-start/getting-started.md)
+- [Hardware Selection](hardware/hardware-selection.md)
+- [FAQ](faq.md)
+- [Blog](blog/index.md)