gitdxd-theme/README.md

75 lines
2.9 KiB
Markdown

# GitDXD — Forgejo theme & homepage
A custom theme + landing page for a self-hosted [Forgejo](https://forgejo.org)
instance. Soft (neumorphic) UI, a colourful default palette, and a
GitHub/GitLab-style logged-out homepage.
## What's inside
| Path | Purpose |
| --- | --- |
| `themes/` | All CSS themes plus the shared neumorphic layer |
| `templates/home.tmpl` | Logged-out landing page |
| `templates/home_forgejo.tmpl` | "Why not GitHub?" section used by the landing page |
| `templates/custom/header.tmpl` | Navbar dark/light toggle (CSS + JS) |
| `assets/img/` | Logo, favicon and the homepage reason icons |
| `app.ini.example` | The only config you need, with **no secrets** |
| `install.sh` | Copies everything into a Forgejo `custom/` directory |
## Themes
| Theme | Notes |
| --- | --- |
| `aurora-light` | **Default.** Soft slate base, blue primary, teal links |
| `aurora-dark` | Neutral-charcoal dark variant |
| `gruvbox-dark` / `gruvbox-light` | Gruvbox palette with the soft-UI layer |
| `gruvbox-soft-dark` | Legacy alias for `gruvbox-dark` |
| `mono-dark` / `mono-light` | Greyscale variants (retired from the default picker) |
| `terminal` | Phosphor-green terminal palette + soft UI |
| `forgejo-dark` / `forgejo-light` / `forgejo-auto` | Overrides of the built-in palettes + soft UI |
`theme-neumorphism.css` is the shared soft-UI layer imported by every theme.
`_base-forgejo-*.css` are snapshots of Forgejo 15.0.0's built-in themes; the
`theme-forgejo-*.css` overrides import them. Replace the snapshots if you
upgrade Forgejo and want the newer built-in palettes.
## Install
1. Copy the files into your Forgejo custom directory:
```sh
./install.sh /path/to/forgejo/custom
```
(Usually `/var/lib/forgejo/custom`, `/home/forgejo/custom`, or the
`CustomPath` shown in *Site Administration → Configuration*.)
2. Add this to `app.ini` and restart Forgejo:
```ini
[ui]
THEMES = forgejo-auto,forgejo-light,forgejo-dark,aurora-dark,aurora-light,gruvbox-dark,gruvbox-light,gruvbox-soft-dark,terminal
DEFAULT_THEME = aurora-light
```
3. Hard-refresh the browser (`Ctrl+Shift+R`). Forgejo serves custom CSS with a
6-hour cache at a version-pinned URL, so a normal reload may keep the old
styles.
## Navbar dark/light toggle
`templates/custom/header.tmpl` injects a neumorphic sun/moon switch into the
navbar (left of *Register* when logged out). It flips between `aurora-light`
and `aurora-dark`, stores the choice in `localStorage` under `dxd-theme`, and
applies it before the page paints.
## Security / no secrets
This repository intentionally contains **only** theme files, templates and
images. It does **not** include `app.ini`, database files, access tokens,
runner credentials, logs, or any user data. `app.ini.example` contains just the
`[ui]` theme settings.
## License
No license is included yet. Add one if you want others to reuse this.