RepoGallery

Just fork & good to go!

A beautiful showcase for all your GitHub repos. 🎨

View Live Demo | And More

English | 繁體中文

✨ Key Advantages ✨

🔹 Easy Setup • ⚡ Automated Deployment
🎨 Customizable • 💎 Modern Design
🔄 Effortless Updates • 🚀 Live Demo Available

⚙️ Prerequisites

Before you start, make sure you have a GitHub account.

🚀 Quick Start

Step 1. Fork This Repository

Click the Fork button at the top right of this page to create your own copy of the repository.

Tip

It’s recommended to keep the repository name as RepoGallery.

Step 2. GitHub Settings

Important

These settings must be configured via the GitHub Website (GitHub Mobile doesn't support these settings).

Make sure your repository is set up correctly:

A. Configure GitHub Pages

Go to Settings > Pages

✅ Set Build and deployment Source to GitHub Actions

B. Enable GitHub Actions

Go to Settings > Actions > General

✅ Set Action permissions to Allow all actions and reusable workflows

C. Enable Workflows

Navigate to the Actions tab

1. You will see the Workflows are disabled in default
   Click the I understand my workflows, go ahead and enable them button

   

2. Select the RepoGallery workflow from the left sidebar
3. You will see the Scheduled workflows are disabled by default in forks warning message
   Click the Enable workflow button

   

Step 3. Manual Trigger GitHub Action (Optional but Recommended)

Tip

If you want to customize your showcase, skip this step and go to Step 4.

To ensure GitHub Actions is working properly, manually trigger the workflow:

1. Go to the Actions tab
2. Select the RepoGallery workflow on the left sidebar
3. Click the Run workflow button

Note

The workflow will also run automatically every day at UTC 00:00 🕛.
Any push to the main branch will also trigger the workflow.

Step 4. Personalization (Optional)

🎨 Customize your showcase by editing the config.yaml. You can:

• Change the website title
• Adjust the theme colors
• and more!

After editing, commit and push your changes.

Tip

If you didn’t manually trigger Step 3, this push will trigger the workflow and deploy your page automatically.
For more usage details, please refer to the config.yaml file.

Step 5. View Your Awesome RepoGallery Page

Once GitHub Actions has successfully run and GitHub Pages is deployed (this may take a few minutes), your showcase will be available at:

📌 https://<your-github-username>.github.io/RepoGallery

Tip

You can also find the URL in your repository’s About settings by clicking Use your GitHub Pages website.

🔄 How to Sync with Upstream

If you want to keep your forked repository updated with the latest changes from the RepoGallery, follow these steps:

A. If you DID NOT modify config.yaml or don’t mind losing your changes

1. Go to your forked repository
2. Click Sync Fork
   
3. Click Discard n commits
   
4. Done!

Warning

If you want to keep your changes, DO NOT click Discard n commits.
This will reset your fork to match the original repository.

B. If you DID modify config.yaml and want to keep your changes

Run the following commands in your terminal:

#!/bin/bash
cd RepoGallery
chmod +x sync.sh
./sync.sh

🛠 How It Works (For the Curious)

When GitHub Actions (repo_gallery.yaml) runs, it automatically executes generate_html.py, which:

1. Reads config.yaml
2. Uses the templates from the templates/ folder to generate a new html file

Then GitHub Actions will deploy the latest changes to GitHub Pages.

Want to learn more?

Check out:

• The scripts inside the script/ folder
• The templates inside the templates/ folder

☕ Buy me a coffee

Enjoying this project? Keep me caffeinated so I can keep improving it!
Support my work on Buy Me a Coffee 💖

📄 License

This project is licensed under the Apache License 2.0