A practical guide to building an impressive GitHub profile using real services and GitHub Actions.
Quick Start · Guides · Templates · Showcase
This header was generated by capsule-render. Your profile could look like this in 10 minutes.
This repo covers the tools and services that power the best GitHub profiles:
- capsule-render for animated headers
- readme-typing-svg for typing animations
- lowlighter/metrics for auto-updating stat images via GitHub Actions
- github-readme-stats for language and stat cards
- shields.io for clean tech stack badges
- Platane/snk for the snake contribution graph animation
- Custom GitHub Actions for pulling in dynamic content (blog posts, weather, WakaTime, etc.)
No design skills required. Each guide is copy-paste ready.
Three steps to a better profile.
1. Create your profile repo. Make a new repository on GitHub with the same name as your username. Initialize it with a README. GitHub will display that README on your profile page. See guide 01 for the full walkthrough.
2. Pick a profile template. Browse profiles/ and choose a starting point:
profiles/minimal/for a clean, professional lookprofiles/developer/for stats, badges, and activityprofiles/advanced/for the full package with GitHub Actions
3. Customize and push. Swap in your username, tweak colors, add your tech stack. Push to your profile repo and you're live.
| Tool | What It Does | Guide |
|---|---|---|
| capsule-render | Generates animated header banners with gradients and text | 02-header |
| readme-typing-svg | Creates a typing text animation for intros and taglines | 03-typing |
| lowlighter/metrics | GitHub Action that produces auto-updating stat images | 04-stats |
| github-readme-stats | Stat cards for languages, commits, streaks, and more | 04-stats |
| shields.io | Badge generator for tech stacks, social links, and status | 05-badges |
| Platane/snk | Generates a snake animation that eats your contribution graph | 06-snake |
| Custom GitHub Actions | Pull in blog feeds, WakaTime, weather, or any API | 08-actions-deep |
Ready-to-use starting points. Copy one, customize, push.
| Template | Description | Preview | Link |
|---|---|---|---|
| Minimal | Name, bio, social links, a typing animation | Capsule header + badges + stat card | profiles/minimal/ |
| Developer | Stats cards, language breakdown, tech badges, recent activity | Animated header + typing + stats + badges + streak | profiles/developer/ |
| Advanced | Everything above plus GitHub Actions for auto-updating content | Full-featured with metrics, snake, and custom Actions | profiles/advanced/ |
Step-by-step walkthroughs from zero to a finished profile. Read them in order or jump to whatever you need.
| Guide | Topic |
|---|---|
| 01-setup | Create your profile repo and understand the basic structure |
| 02-header | Add an animated header banner with capsule-render |
| 03-typing | Add a typing text animation for your intro |
| 04-stats | Display your stats with lowlighter/metrics and github-readme-stats |
| 05-badges | Build a tech stack section with shields.io badges |
| 06-snake | Add a snake eating your contribution graph |
| 07-layout | Put everything together into a polished layout |
| 08-actions-deep | Write custom GitHub Actions for dynamic content |
Copy-paste code snippets are available in snippets/. Ready-to-use workflow files live in workflows/.
See what others have built. Real profiles, real results.
Add your profile by submitting a PR to the showcase.
Contributions welcome. Read the Contributing Guide to get started.
Ways to help:
- Add or improve a profile template
- Write or update a guide
- Fix bugs or improve existing snippets
- Submit your profile to the showcase
Please follow our Code of Conduct.
MIT. Use it, fork it, remix it. Attribution appreciated but not required.
Found this useful? Star the repo to help others find it.