@@ -160,41 +160,41 @@ URL Parameter > Theme Default > System Fallback
160160
161161> All parameters below are optional except ` user ` . Append them to the base URL as query string key-value pairs (e.g. ` ?user=YOUR_USERNAME&theme=neon&size=large ` ). Boolean parameters accept ` true ` or ` false ` . Hex color values are provided ** without** the ` # ` prefix.
162162
163- | Parameter | Description | Default | Allowed Values / Constraints | Example |
164- | ----------------- | ---------------------------------------------------- | ------------------ | ------------------------------------------------------ | ------------------------ |
165- | ` user ` | GitHub username to render (Required) | — | Any valid GitHub username | ` ?user=jhasourav07 ` |
166- | ` theme ` | Preset theme name | ` dark ` | ` auto ` , ` dark ` , ` neon ` , ` dracula ` , ` github ` , ` light ` , ` gruvbox ` , ` random ` , etc. | ` ?theme=dracula ` |
167- | ` bg ` | Background color | Theme default | Hex color code (without ` # ` ) | ` ?bg=0d1117 ` |
168- | ` accent ` | Tower & glow color | Theme default | Hex color code (without ` # ` ) | ` ?accent=58a6ff ` |
169- | ` text ` | Label & stat text color | Theme default | Hex color code (without ` # ` ) | ` ?text=c9d1d9 ` |
170- | ` radius ` | Border corner radius in pixels | ` 8 ` | Numeric value | ` ?radius=16 ` |
171- | ` border ` | Custom stroke color around the SVG container | — | Hex color code (without ` # ` ) | ` ?border=ff0000 ` |
172- | ` speed ` | Radar scan duration | ` 8s ` | ` 2s ` –` 20s ` | ` ?speed=4s ` |
173- | ` scale ` | Tower height scaling | ` linear ` | ` linear ` , ` log ` | ` ?scale=log ` |
174- | ` size ` | Badge dimensions | ` medium ` | ` small ` , ` medium ` , ` large ` | ` ?size=large ` |
175- | ` font ` | Custom font for text | Default typography | Any valid Google Font name | ` ?font=Orbitron ` |
176- | ` refresh ` | Bypass cache for real-time data | ` false ` | ` true ` , ` false ` | ` ?refresh=true ` |
177- | ` year ` | Calendar year to render | Current year | ` 2023 ` , ` 2024 ` , etc. | ` ?year=2023 ` |
178- | ` hide_title ` | Hide GitHub username/title | ` false ` | ` true ` , ` false ` | ` ?hide_title=true ` |
179- | ` hide_background ` | Remove the background rect | ` false ` | ` true ` , ` false ` | ` ?hide_background=true ` |
180- | ` hide_stats ` | Hide bottom row displaying stats | ` false ` | ` true ` , ` false ` | ` ?hide_stats=true ` |
181- | ` tz ` | IANA timezone | ` UTC ` | Valid IANA timezone | ` ?tz=Asia/Kolkata ` |
182- | ` lang ` | Language code for labels | ` en ` | ` en ` , ` es ` , ` hi ` , ` fr ` , ` pt ` , ` ko ` , ` ja ` , ` de ` , ` zh ` | ` ?lang=hi ` |
183- | ` view ` | Rendering mode | ` default ` | ` default ` , ` monthly ` , ` heatmap ` | ` ?view=heatmap ` |
184- | ` entrance ` | Entrance animation for towers | ` rise ` | ` rise ` , ` fade ` , ` slide ` , ` none ` | ` ?entrance=fade ` |
185- | ` delta_format ` | Month-over-month delta format (` view=monthly ` ) | ` percent ` | ` percent ` , ` absolute ` , ` both ` | ` ?delta_format=absolute ` |
186- | ` width ` | Custom width for SVG canvas (` view=monthly ` ) | ` 300 ` | Numeric value | ` ?width=400 ` |
187- | ` height ` | Custom height for SVG canvas (` view=monthly ` ) | ` 120 ` | Numeric value | ` ?height=150 ` |
188- | ` grace ` | Grace period in days before streak resets (see [ Grace Period Examples] ( #grace-period-examples ) ) | ` 1 ` | ` 0 ` –` 7 ` | ` ?grace=2 ` |
189- | ` mode ` | Base data rendering mode | ` commits ` | ` commits ` , ` loc ` | ` ?mode=loc ` |
190- | ` repo ` | Render monolith for a specific repository | — | ` owner/repo ` | ` ?repo=vercel/next.js ` |
191- | ` org ` | Organization name to generate a Mega-City for | — | Valid GitHub organization name | ` ?org=vercel ` |
192- | ` labels ` | Render optional isometric month/weekday labels | ` false ` | ` true ` , ` false ` | ` ?labels=true ` |
193- | ` labelColor ` | Custom text color for isometric labels | — | Hex color code (without ` # ` ) | ` ?labelColor=ffffff ` |
194- | ` versus ` | Compare against an opponent side-by-side | — | Any valid GitHub username | ` ?versus=octocat ` |
195- | ` shading ` | Apply intensity-based opacity shading to tower faces | ` false ` | ` true ` , ` false ` | ` ?shading=true ` |
196- | ` opacity ` | Global opacity scalar for tower fill | ` 1.0 ` | ` 0.1 ` –` 1.0 ` | ` ?opacity=0.8 ` |
197- | ` gradient ` | Show volumetric gradients on the floor | ` false ` | ` true ` , ` false ` | ` ?gradient=true ` |
163+ | Parameter | Description | Default | Allowed Values / Constraints | Example |
164+ | ----------------- | ----------------------------------------------------------------------------------------------- | ------------------ | ------------------------- ------------------------------------------------------ | ------------------------ |
165+ | ` user ` | GitHub username to render (Required) | — | Any valid GitHub username | ` ?user=jhasourav07 ` |
166+ | ` theme ` | Preset theme name | ` dark ` | ` auto ` , ` dark ` , ` neon ` , ` dracula ` , ` github ` , ` light ` , ` gruvbox ` , ` random ` , etc. | ` ?theme=dracula ` |
167+ | ` bg ` | Background color | Theme default | Hex color code (without ` # ` ) | ` ?bg=0d1117 ` |
168+ | ` accent ` | Tower & glow color | Theme default | Hex color code (without ` # ` ) | ` ?accent=58a6ff ` |
169+ | ` text ` | Label & stat text color | Theme default | Hex color code (without ` # ` ) | ` ?text=c9d1d9 ` |
170+ | ` radius ` | Border corner radius in pixels | ` 8 ` | Numeric value | ` ?radius=16 ` |
171+ | ` border ` | Custom stroke color around the SVG container | — | Hex color code (without ` # ` ) | ` ?border=ff0000 ` |
172+ | ` speed ` | Radar scan duration | ` 8s ` | ` 2s ` –` 20s ` | ` ?speed=4s ` |
173+ | ` scale ` | Tower height scaling | ` linear ` | ` linear ` , ` log ` | ` ?scale=log ` |
174+ | ` size ` | Badge dimensions | ` medium ` | ` small ` , ` medium ` , ` large ` | ` ?size=large ` |
175+ | ` font ` | Custom font for text | Default typography | Any valid Google Font name | ` ?font=Orbitron ` |
176+ | ` refresh ` | Bypass cache for real-time data | ` false ` | ` true ` , ` false ` | ` ?refresh=true ` |
177+ | ` year ` | Calendar year to render | Current year | ` 2023 ` , ` 2024 ` , etc. | ` ?year=2023 ` |
178+ | ` hide_title ` | Hide GitHub username/title | ` false ` | ` true ` , ` false ` | ` ?hide_title=true ` |
179+ | ` hide_background ` | Remove the background rect | ` false ` | ` true ` , ` false ` | ` ?hide_background=true ` |
180+ | ` hide_stats ` | Hide bottom row displaying stats | ` false ` | ` true ` , ` false ` | ` ?hide_stats=true ` |
181+ | ` tz ` | IANA timezone | ` UTC ` | Valid IANA timezone | ` ?tz=Asia/Kolkata ` |
182+ | ` lang ` | Language code for labels | ` en ` | ` en ` , ` es ` , ` hi ` , ` fr ` , ` pt ` , ` ko ` , ` ja ` , ` de ` , ` zh ` | ` ?lang=hi ` |
183+ | ` view ` | Rendering mode | ` default ` | ` default ` , ` monthly ` , ` heatmap ` | ` ?view=heatmap ` |
184+ | ` entrance ` | Entrance animation for towers | ` rise ` | ` rise ` , ` fade ` , ` slide ` , ` none ` | ` ?entrance=fade ` |
185+ | ` delta_format ` | Month-over-month delta format (` view=monthly ` ) | ` percent ` | ` percent ` , ` absolute ` , ` both ` | ` ?delta_format=absolute ` |
186+ | ` width ` | Custom width for SVG canvas (` view=monthly ` ) | ` 300 ` | Numeric value | ` ?width=400 ` |
187+ | ` height ` | Custom height for SVG canvas (` view=monthly ` ) | ` 120 ` | Numeric value | ` ?height=150 ` |
188+ | ` grace ` | Grace period in days before streak resets (see [ Grace Period Examples] ( #grace-period-examples ) ) | ` 1 ` | ` 0 ` –` 7 ` | ` ?grace=2 ` |
189+ | ` mode ` | Base data rendering mode | ` commits ` | ` commits ` , ` loc ` | ` ?mode=loc ` |
190+ | ` repo ` | Render monolith for a specific repository | — | ` owner/repo ` | ` ?repo=vercel/next.js ` |
191+ | ` org ` | Organization name to generate a Mega-City for | — | Valid GitHub organization name | ` ?org=vercel ` |
192+ | ` labels ` | Render optional isometric month/weekday labels | ` false ` | ` true ` , ` false ` | ` ?labels=true ` |
193+ | ` labelColor ` | Custom text color for isometric labels | — | Hex color code (without ` # ` ) | ` ?labelColor=ffffff ` |
194+ | ` versus ` | Compare against an opponent side-by-side | — | Any valid GitHub username | ` ?versus=octocat ` |
195+ | ` shading ` | Apply intensity-based opacity shading to tower faces | ` false ` | ` true ` , ` false ` | ` ?shading=true ` |
196+ | ` opacity ` | Global opacity scalar for tower fill | ` 1.0 ` | ` 0.1 ` –` 1.0 ` | ` ?opacity=0.8 ` |
197+ | ` gradient ` | Show volumetric gradients on the floor | ` false ` | ` true ` , ` false ` | ` ?gradient=true ` |
198198
199199### Grace Period Examples
200200
@@ -590,4 +590,3 @@ Thanks to all contributors who have helped make CommitPulse better!
590590 </a >
591591
592592<sub >View the [ full contributor list →] ( https://github.com/JhaSourav07/commitpulse/graphs/contributors ) </sub >
593-
0 commit comments