From ffb18e54e11fb56aa52b1b5c538a84a2a0d93eab Mon Sep 17 00:00:00 2001 From: Dongho Kim Date: Thu, 4 Dec 2025 11:53:09 +0100 Subject: [PATCH] markdown --- README.md | 90 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 69 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 43ba2e5..e4d8482 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,74 @@ -# Gitea Bootstrap 5 Landing Page Theme +# Gitea Ocean Theme -A drop-in theme that replaces the public front page of a Gitea instance with a modern Bootstrap 5 + Font Awesome experience. Signed-in users see a refreshed quick-action dashboard row, while guests get a marketing-style hero layout with prominent calls to action. +A beautiful, clean pastel ocean-themed template for Gitea featuring soft blues, rounded corners, and glassmorphism effects. This theme transforms your Gitea instance into a cohesive, modern experience with whale animations and ocean motifs throughout. -![Screenshot of the customized Gitea home landing page showing the Bootstrap hero layout, quick actions, and footer enhancements](asset/snap1.png) +![Gitea Ocean Theme Screenshot](asset/snap1.png) -## What's Included +## ✨ Features + +- **🌊 Ocean-themed aesthetic** – Soft pastel blues (#8CA9FF, #AAC4F5) with cream backgrounds (#FFF8DE) +- **🐋 Animated whale hero** – Welcoming landing page with swimming whale animation +- **💎 Glassmorphism design** – Rounded corners, semi-transparent cards, subtle shadows +- **📱 Fully responsive** – Clean layout adapting to all screen sizes +- **🎨 Cohesive styling** – Dashboard, repositories, footer all matching the ocean theme +- **⚡ Modern tech stack** – Bootstrap 5.3.3, Font Awesome 6.5.2, Google Fonts (Inter) + +## 📦 What's Included - `custom/templates/home.tmpl` – overrides the default landing page with a Bootstrap 5 design -- `custom/templates/custom/header.tmpl` – injects Bootstrap, Font Awesome, typography, and inlined theme styles -- `custom/templates/custom/body_inner_pre.tmpl` – adds a compact promotional banner above the navigation bar -- `custom/templates/custom/footer.tmpl` – delivers a multi-column footer with curated resource links +- `custom/templates/custom/header.tmpl` – injects Bootstrap, Font Awesome, typography, and all ocean theme styles +- `custom/templates/custom/body_inner_post.tmpl` – adds JavaScript for repository card styling +- `custom/templates/custom/footer.tmpl` – delivers a multi-column footer with ocean theme styling +- `custom/public/css/home.css` – additional home page styling -## Prerequisites +## 📋 Prerequisites - Gitea 1.18+ (tested against the current `main` template structure) -- Access to the `custom/` directory on your Alpine Linux host (default `/var/lib/gitea/custom` when using the official packages) +- Access to the `custom/` directory on your Gitea host (default `/var/lib/gitea/custom` when using official packages) -## Installation +## 🚀 Installation 1. **Stop Gitea (optional but safest):** ```sh sudo rc-service gitea stop ``` + 2. **Copy the theme files:** ```sh sudo rsync -av custom/ /var/lib/gitea/custom/ ``` Adjust the destination path if your `APP_DATA_PATH` differs. + 3. **Fix permissions:** ```sh sudo chown -R git:git /var/lib/gitea/custom ``` Replace `git:git` with the user/group running your Gitea service. + 4. **Start or restart Gitea:** ```sh sudo rc-service gitea start ``` + 5. **Bust caches (optional but recommended):** add or increment `ui.asset_version` in `app.ini`, or clear `$GITEA_CUSTOM/public` cache if you use a CDN. -## Configuration Tips +## 🎨 Design Details -- No configuration changes are required, but you can force the refreshed styles to load by setting `ui.use_service_worker = false` if you rely on aggressive caching. -- To adjust colors or typography, edit the `