91 lines
2.2 KiB
Markdown
91 lines
2.2 KiB
Markdown
# Git-Pages Template
|
|
|
|
This repository is a template for deploying static sites to your Git-Pages server at `pages.ntiforo.net`.
|
|
|
|
## 🚀 How It Works
|
|
|
|
1. **Use this template** to create a new repository
|
|
2. **Push your static site** to the `.index/` directory
|
|
3. **Forgejo Action** automatically deploys on push to `main` or `pages`
|
|
4. **Your site is live** at `https://pages.ntiforo.net/<repo-name>/`
|
|
|
|
## 📁 Structure
|
|
|
|
```
|
|
.
|
|
├── .forgejo/
|
|
│ └── workflows/
|
|
│ └── publish.yml # Auto-deployment workflow
|
|
├── .index/
|
|
│ └── index.html # Your site contents
|
|
├── README.md # This file
|
|
└── .gitignore # Git ignore rules
|
|
```
|
|
|
|
## 🛠️ Setup
|
|
|
|
### 1. Create Repository from Template
|
|
|
|
Click **"Use this template"** → Create new repository
|
|
|
|
### 2. Add Secret
|
|
|
|
Go to: **Settings → Secrets → Actions → New secret**
|
|
|
|
- **Name:** `GIT_PAGES_PASSWORD`
|
|
- **Value:** Your git-pages server password
|
|
|
|
### 3. Push Your Site
|
|
|
|
Replace `.index/index.html` with your content, then:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Initial site"
|
|
git push origin main
|
|
```
|
|
|
|
## 📝 Customization
|
|
|
|
### Add More Pages
|
|
|
|
Create additional HTML files in `.index/`:
|
|
|
|
```
|
|
.index/
|
|
├── index.html # Homepage (https://pages.ntiforo.net/repo/)
|
|
├── about.html # About page (https://pages.ntiforo.net/repo/about.html)
|
|
└── css/
|
|
└── styles.css # Custom styles
|
|
```
|
|
|
|
### Update Workflow
|
|
|
|
Edit `.forgejo/workflows/publish.yml` to:
|
|
- Change the site URL
|
|
- Add build steps (e.g., for static site generators)
|
|
- Customize deployment behavior
|
|
|
|
## 🔐 Security
|
|
|
|
- Keep `GIT_PAGES_PASSWORD` secret secure
|
|
- Only push to trusted repositories
|
|
- Consider using forge token authorization instead of password (see git-pages docs)
|
|
|
|
## 🎯 Examples
|
|
|
|
- Single page site: Just use `.index/index.html`
|
|
- Multi-page site: Add more HTML files to `.index/`
|
|
- Static site generator: Add build step, output to `.index/`
|
|
|
|
## 📚 Resources
|
|
|
|
- [Git-Pages Documentation](https://git-pages.org)
|
|
- [Git-Pages Action](https://codeberg.org/git-pages/action)
|
|
- [Git-Pages CLI](https://codeberg.org/git-pages/git-pages-cli)
|
|
|
|
---
|
|
|
|
**Created by:** Cammy 💦
|
|
**Date:** 2026-04-01
|