English | 简体中文

---

🖼️ Preview

All previews below are live — pulled directly from the demo profile zyh3699/zyh3699.

Banner + Badges

Skills & Tools

Contribution Stats

Snake Animation

Profile Details + 3D Contribution Graph

---

✨ Features

• Waving banner with gradient title and subtitle via capsule-render
• Typing SVG — animated rotating taglines (Fira Code font)
• Social badges — GitHub, Email, ORCID, Google Scholar, 小红书
• Page view counter (komarev.com) + Stars badge
• Skills & Tools — icon grid via skillicons.dev
• Contribution stats — three summary cards (tokyonight theme)
• Snake animation — light/dark mode responsive, auto-updated daily
• Contribution heatmap — profile-details card + 3D rainbow graph
• Footer — wave animation + closing line

---

🚀 Quick Start

Step 1 — Create your special repository

GitHub renders a README.md as your profile page when the repo name exactly matches your username.

1. Go to github.com/new
2. Set the repository name to your GitHub username (e.g. zyh3699)
3. Make it Public
4. Check Add a README file
5. Click Create repository

Step 2 — Copy the template

1. Open zyh3699/zyh3699 → click Raw
2. Select all → copy
3. Paste into your new repo's README.md
4. Replace every occurrence of zyh3699 with your username

Step 3 — Update your links

Find and replace the following placeholders:

Placeholder	Replace with
zyh3699	your GitHub username
zephyrzhong248@gmail.com	your email
0009-0003-0132-2036	your ORCID
your-id (Google Scholar)	your Scholar user ID
小红书 profile URL	your profile URL (or remove the badge)

Step 4 — Set up GitHub Actions

The snake animation and 3D contribution graph require two workflows. See Actions Setup below.

Step 5 — Push and preview

Commit your changes, then visit github.com/YOUR_USERNAME to see your live profile.

---

⚙️ GitHub Actions Setup

Copy the two workflow files from .github/workflows/ in this repo into your repo's .github/workflows/ folder.

Snake Animation (snake.yml)

Generates a contribution grid snake animation and pushes it to the output branch.

Required permissions:

1. Go to your repo → Settings → Actions → General
2. Under Workflow permissions, select Read and write permissions
3. Save

First run:

Go to Actions → Generate Snake Animation → Run workflow

The snake SVG will be available at:

https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/github-contribution-grid-snake-dark.svg
https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/github-contribution-grid-snake.svg

After the first run, it updates automatically every day at midnight.

---

3D Contribution Graph (profile-3d.yml)

Generates a 3D animated contribution graph and pushes it to main.

Required: Personal Access Token

This workflow needs write access via a PAT (the default GITHUB_TOKEN has read-only scope for pushes across repos).

1. Go to github.com/settings/tokens → Generate new token (classic)
2. Give it a name (e.g. PROFILE_TOKEN)
3. Select scope: ✅ repo
4. Generate and copy the token
5. Go to your repo → Settings → Secrets and variables → Actions → New repository secret
6. Name: TOKEN · Value: paste your token
7. Save

First run:

Go to Actions → 3D Contribution Graph → Run workflow

The graph will be available at:

https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/main/profile-3d-contrib/profile-night-rainbow.svg

After the first run, it updates automatically every day at 18:00 UTC.

---

🎨 Customization

Color scheme

The template uses a violet → cyan gradient. Key color values:

Role	Hex
Primary (violet)	#7C3AED
Secondary (cyan)	#06B6D4
Mid gradient	#4E7FD4
Accent (light violet)	#A78BFA

To change the scheme, replace these values in the banner, footer, badges, and stats card theme.

Typing SVG taglines

Edit the lines= parameter in the Typing SVG URL. Separate lines with ;. URL-encode spaces as + and special characters accordingly.

Skill icons

Edit the i= parameter in the skillicons.dev URL:

https://skillicons.dev/icons?i=python,pytorch,tensorflow,docker,...&perline=9

Full icon list: skillicons.dev

Stats card theme

Change theme=tokyonight to any supported theme: dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, dracula

3D graph colors

Edit profile-3d-contrib/settings.json and the matching step in .github/workflows/profile-3d.yml:

{
  "type": "rainbow",
  "backgroundColor": "#0d1117",
  "radarColor": "#7C3AED",
  "growingAnimation": true,
  "contribColors": ["#161b22", "#2D1B69", "#5B21B6", "#7C3AED", "#06B6D4"]
}

Note: Always update both the settings.json file and the workflow's inline JSON — the workflow regenerates settings.json on every run.

---

📄 License

MIT — free to use, modify, and distribute. See LICENSE.

If this template helped you, consider leaving a ⭐ — it helps others find it.