feat: apply CYBERTEC changes after fork

.github/workflows/release.yaml

@@ -0,0 +1,42 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - dev
+
+env:
+  RELEASE_TAR: ./dist/hugo-geekdoc.tar.gz
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build assets
+        run: npm run build
+
+      - name: Pack
+        run: npm run pack
+
+      - name: Extract release to directory
+        run: |
+          tar -xf ./dist/hugo-geekdoc.tar.gz -C ./dist; rm ./dist/hugo-geekdoc.tar.gz
+
+      - name: Push to main branch
+        uses: s0/git-publish-subdir-action@develop
+        env:
+          REPO: self
+          BRANCH: main
+          FOLDER: dist
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SQUASH_HISTORY: true

.gitignore

@@ -1,4 +1,5 @@
 # local environments
+.idea
 .swp
 .env*
 /dist/
@@ -15,9 +16,8 @@ VERSION
 exampleSite/content/de
 
 # auto-generated files
-/data/
+/data/assets.json
 /static/
-/assets/sprites/
 /resources/
 /exampleSite/resources/
 /exampleSite/data/sprites/

.tarignore

@@ -20,6 +20,7 @@ local*
 dist
 src
 build
+images
 renovate*
 resources
 CONTRIBUTING.md

README.md

@@ -1,4 +1,70 @@
-# Geekdoc
+# CYBERTEC Geekdoc
+
+A CYBERTEC themed fork of [geekdoc](https://github.com/thegeeklab/hugo-geekdoc), a Hugo theme made for documentation.
+
+---
+
+## Requirements
+
+- [`go`](https://go.dev/doc/install)
+- [`hugo`](https://gohugo.io/installation/)
+
+## Usage
+
+Initialize a new hugo site:
+
+```shell
+hugo new site <site-name>
+cd <site-name>
+```
+
+Initialize the site as a go module:
+
+```shell
+hugo mod init github.com/cybertec-postgresql/<repository-name>
+```
+
+Add the following to your `hugo.toml` to use this theme, including functional code-highlighting:
+
+```toml
+# hugo.toml
+pygmentsCodeFences = true
+pygmentsUseClasses = true
+
+[module]
+[[module.imports]]
+path = 'github.com/cybertec-postgresql/hugo-geekdoc'
+```
+
+Fetch the module
+
+```shell
+hugo mod get -u
+```
+
+Build your page
+```shell
+hugo --minify
+# You may optionally overwrite the `baseURL`
+hugo --minify -b "/docs/"
+```
+
+## Update
+
+To retrieve the latest version of this theme, simply run
+
+```shell
+hugo mod get -u
+hugo mod tidy
+```
+
+## Development
+
+The fork and source code is located inside the `dev` branch. On push, a GitHub Actions workflow will build and push the release to the `main` branch.
+
+The contents below are from the original Geekdoc README.
+
+---
 
 [![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/hugo-geekdoc/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)
 [![Hugo Version](https://img.shields.io/badge/hugo-0.112-blue.svg)](https://gohugo.io)