Skip to content

Commit dbb676c

Browse files
authored
docs: Add complete THEMES.md gallery with all 13 themes (JhaSourav07#553)
## Description Creates a complete THEMES.md gallery with preview images, color swatches for all 13 themes using live commitpulse.vercel.app URLs. Fixes JhaSourav07#385 ## Pillar - [ ] 🎨 Pillar 1 β€” New Theme Design - [ ] πŸ“ Pillar 2 β€” Geometric SVG Improvement - [ ] πŸ• Pillar 3 β€” Timezone Logic Optimization - [x] πŸ› οΈ Other (Bug fix, refactoring, docs) ## Visual Preview N/A ## Checklist before requesting a review: - [x] I have read the `CONTRIBUTING.md` file. - [x] I have tested these changes locally (`localhost:3000/api/streak?user=YOUR_USERNAME`). - [x] I have run `npm run format` and `npm run lint` locally and resolved all errors (CI will fail otherwise). - [x] My commits follow the Conventional Commits format (e.g., `feat(themes): ...`, `fix(calculate): ...`). - [ ] I have updated `README.md` if I added a new theme or URL parameter. - [x] I have started the repo. - [x] I have made sure that i have only one commit to merge in this PR. - [ ] The SVG output matches the CommitPulse "premium quality" aesthetic standard (no raw elements, smooth animations, correct fonts). - [ ] (Recommended) I joined the CommitPulse Discord community for contributor discussions, mentorship, and faster PR support.
2 parents 6707794 + f57604c commit dbb676c

1 file changed

Lines changed: 53 additions & 67 deletions

File tree

β€ŽTHEMES.mdβ€Ž

Lines changed: 53 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,91 @@
1-
# 🎨 CommitPulse Theme Gallery
1+
# 🎨 CommitPulse Themes
22

3-
This gallery showcases all available themes for the CommitPulse streak card.
3+
All 13 available themes for your CommitPulse badge. Use the `?theme=<slug>` query parameter to apply a
4+
theme.
45

5-
---
6-
7-
## πŸŒ‘ Neon
8-
9-
![Neon](assets/themes/neon.png)
10-
11-
Usage: `/api/streak?user=yourusername&theme=neon`
6+
```
7+
https://commitpulse.vercel.app/api/badge?username=YOUR_USERNAME&theme=<slug>
8+
```
129

1310
---
1411

15-
## πŸ§› Dracula
16-
17-
![Dracula](assets/themes/dracula.png)
18-
19-
Usage: `/api/streak?user=yourusername&theme=dracula`
12+
## Theme Gallery
13+
14+
| Theme | Background | Text | Accent |
15+
| ------------ | ---------- | --------- | --------- |
16+
| dark | `#0d1117` | `#c9d1d9` | `#58a6ff` |
17+
| light | `#ffffff` | `#24292f` | `#0969da` |
18+
| neon | `#000000` | `#00ffcc` | `#ff00ff` |
19+
| github | `#0d1117` | `#ffffff` | `#238636` |
20+
| dracula | `#282a36` | `#f8f8f2` | `#bd93f9` |
21+
| ocean | `#0a192f` | `#ccd6f6` | `#64ffda` |
22+
| sunset | `#1a0a0a` | `#ffd6c0` | `#ff6b35` |
23+
| forest | `#0d1f0d` | `#c8f0c8` | `#39d353` |
24+
| rose | `#1f0d14` | `#f0c8d4` | `#ff6b9d` |
25+
| nord | `#2e3440` | `#d8dee9` | `#88c0d0` |
26+
| synthwave | `#0d0221` | `#f8f8f2` | `#ff2d78` |
27+
| gruvbox | `#282828` | `#ebdbb2` | `#fe8019` |
28+
| highcontrast | `#0a0a0a` | `#888888` | `#ff4500` |
2029

2130
---
2231

23-
## πŸŒ‘ Dark
32+
## Preview URLs
2433

25-
![Dark](assets/themes/dark.png)
34+
Use these URLs to preview each theme in your README:
2635

27-
Usage: `/api/streak?user=yourusername&theme=dark`
36+
**dark**
2837

29-
---
38+
![dark](https://commitpulse.vercel.app/api/badge?username=demo&theme=dark)
3039

31-
## 🀍 Light
40+
**light**
3241

33-
![Light](assets/themes/light.png)
42+
![light](https://commitpulse.vercel.app/api/badge?username=demo&theme=light)
3443

35-
Usage: `/api/streak?user=yourusername&theme=light`
44+
**neon**
3645

37-
---
46+
![neon](https://commitpulse.vercel.app/api/badge?username=demo&theme=neon)
3847

39-
## πŸ™ GitHub
48+
**github**
4049

41-
![GitHub](assets/themes/github.png)
50+
![github](https://commitpulse.vercel.app/api/badge?username=demo&theme=github)
4251

43-
Usage: `/api/streak?user=yourusername&theme=github`
52+
**dracula**
4453

45-
---
54+
![dracula](https://commitpulse.vercel.app/api/badge?username=demo&theme=dracula)
4655

47-
## 🟠 Gruvbox
56+
**ocean**
4857

49-
![Gruvbox](assets/themes/gruvbox.png)
58+
![ocean](https://commitpulse.vercel.app/api/badge?username=demo&theme=ocean)
5059

51-
Usage: `/api/streak?user=yourusername&theme=gruvbox`
60+
**sunset**
5261

53-
---
62+
![sunset](https://commitpulse.vercel.app/api/badge?username=demo&theme=sunset)
5463

55-
## 🌊 Ocean
64+
**forest**
5665

57-
![Ocean](assets/themes/ocean.png)
66+
![forest](https://commitpulse.vercel.app/api/badge?username=demo&theme=forest)
5867

59-
Usage: `/api/streak?user=yourusername&theme=ocean`
68+
**rose**
6069

61-
---
70+
![rose](https://commitpulse.vercel.app/api/badge?username=demo&theme=rose)
6271

63-
## πŸŒ… Sunset
72+
**nord**
6473

65-
![Sunset](assets/themes/sunset.png)
74+
![nord](https://commitpulse.vercel.app/api/badge?username=demo&theme=nord)
6675

67-
Usage: `/api/streak?user=yourusername&theme=sunset`
76+
**synthwave**
6877

69-
---
78+
![synthwave](https://commitpulse.vercel.app/api/badge?username=demo&theme=synthwave)
7079

71-
## 🌲 Forest
80+
**gruvbox**
7281

73-
![Forest](assets/themes/forest.png)
82+
![gruvbox](https://commitpulse.vercel.app/api/badge?username=demo&theme=gruvbox)
7483

75-
Usage: `/api/streak?user=yourusername&theme=forest`
84+
**highcontrast**
7685

77-
---
78-
79-
## 🌹 Rose
80-
81-
![Rose](assets/themes/rose.png)
82-
83-
Usage: `/api/streak?user=yourusername&theme=rose`
86+
![highcontrast](https://commitpulse.vercel.app/api/badge?username=demo&theme=highcontrast)
8487

8588
---
8689

87-
## ❄️ Nord
88-
89-
![Nord](assets/themes/nord.png)
90-
91-
Usage: `/api/streak?user=yourusername&theme=nord`
92-
93-
## πŸŒ† Synthwave
94-
95-
![Synthwave](assets/themes/synthwave.png)
96-
97-
Retro 80s-inspired palette β€” deep indigo background, neon pink glow, crisp white text.
98-
99-
Usage: `/api/streak?user=yourusername&theme=synthwave`
100-
101-
## πŸ”₯ High Contrast
102-
103-
Near-black background with vivid red-orange accent and medium-grey text β€” maximum legibility on both solid and transparent backgrounds for low-vision accessibility.
104-
105-
Usage: `/api/streak?user=yourusername&theme=highcontrast`
90+
> πŸ’‘ **Tip:** Use `?theme=auto` to automatically switch between `light` and `dark` based on the
91+
> viewer's OS setting.

0 commit comments

Comments
Β (0)