Skip to content

docs(readme): add full query-param matrix with examples and defaults #747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shanvi-jakhwal wants to merge 5 commits into
base: main
Choose a base branch
from
+23 −23
Open

docs(readme): add full query-param matrix with examples and defaults #747

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0fc6651
docs(readme): add allowed values and examples to query-param matrix
shanvi-jakhwal May 27, 2026
78d63c4
docs: fix prettier formatting in README
shanvi-jakhwal May 27, 2026
d628d71
Merge branch 'main' into main
shanvi-jakhwal May 28, 2026
99309ea
style: run npm format
shanvi-jakhwal May 28, 2026
12e6d63
Merge branch 'main' of https://github.com/shanvi-jakhwal/commitpulse
shanvi-jakhwal May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,29 +137,29 @@ URL Parameter > Theme Default > System Fallback

### Parameter Reference

| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `user` | `string` | ✅ **Yes** | — | GitHub username to render |
| `theme` | `string` | No | `dark` | Preset theme name (see below) |
| `bg` | `hex` | No | Theme default | Background color — **without** `#` |
| `accent` | `hex` | No | Theme default | Tower & glow color — **without** `#` |
| `text` | `hex` | No | Theme default | Label & stat text color — **without** `#` |
| `radius` | `number` | No | `8` | Border corner radius in pixels |
| `speed` | `string` | No | `8s` | Radar scan duration (`2s`–`20s`, default `8s`) |
| `scale` | `string` | No | `linear` | Tower height scaling: `linear` or `log` (logarithmic) |
| `size` | `string` | No | `medium` | Badge dimensions: `small` (400×280), `medium` (600×420), `large` (800×560) |
| `font` | `string` | No | CommitPulse default typography | Any **Google Font** name (e.g. `Orbitron`, `Inter`) |
| `refresh` | `boolean` | No | `false` | Bypass cache for real-time data |
| `year` | `string` | No | — | Calendar year to render (e.g. `2023`, `2024`) |
| `hide_title` | `boolean` | No | `false` | Hide GitHub username/title from the SVG badge |
| `hide_background` | `boolean` | No | `false` | Remove the background rect, letting the monolith float on the page |
| `hide_stats` | `boolean` | No | `false` | Hides the bottom row displaying Current Streak, Annual Sync Total, and Peak Streak stats when set to `true` or `1`. |
| `tz` | `string` | No | Omitted = UTC | IANA timezone (e.g. `Asia/Kolkata`, `America/New_York`) — aligns "today" with the user local midnight. Note: `?tz=UTC` is valid but cached separately from omitting `tz`. |
| `lang` | `string` | No | `en` | Language code for labels (`en`, `es`, `hi`, `fr`, `pt`, `ko`, `ja`) |
| `view` | `string` | No | `default` | Rendering mode: `default` (3D Monolith) or `monthly` (Compact monthly stats) |
| `delta_format` | `string` | No | `percent` | Format for month-over-month delta in monthly view: `percent` (e.g. +12%), `absolute` (e.g. +15 commits), or `both` |
| `width` | `number` | No | `300` | Custom width for the SVG canvas (currently only applies to `view=monthly`) |
| `height` | `number` | No | `120` | Custom height for the SVG canvas (currently only applies to `view=monthly`) |
| Parameter | Type | Required | Default | Allowed Values | Example |
| ----------------- | --------- | ---------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| `user` | `string` | ✅ **Yes** | — | Any valid GitHub username | `?user=jhasourav07` |
| `theme` | `string` | No | `dark` | `auto`, `dark`, `light`, `neon`, `dracula`, `github`, `gruvbox`, `ocean`, `sunset`, `forest`, `rose`, `nord`, `synthwave`, `highcontrast`, `random` | `?theme=dracula` |
| `bg` | `hex` | No | Theme default | Any hex color **without** `#` | `?bg=0d1117` |
| `accent` | `hex` | No | Theme default | Any hex color **without** `#` | `?accent=ff6b35` |
| `text` | `hex` | No | Theme default | Any hex color **without** `#` | `?text=ffffff` |
| `radius` | `number` | No | `8` | Any positive integer (pixels) | `?radius=16` |
| `speed` | `string` | No | `8s` | `2s` – `20s` | `?speed=4s` |
| `scale` | `string` | No | `linear` | `linear`, `log` | `?scale=log` |
| `size` | `string` | No | `medium` | `small` (400×280), `medium` (600×420), `large` (800×560) | `?size=large` |
| `font` | `string` | No | CommitPulse default | Any Google Font name | `?font=Orbitron` |
| `refresh` | `boolean` | No | `false` | `true`, `false` | `?refresh=true` |
| `year` | `string` | No | Current year | Any valid calendar year e.g. `2023`, `2024` | `?year=2023` |
| `hide_title` | `boolean` | No | `false` | `true`, `false` | `?hide_title=true` |
| `hide_background` | `boolean` | No | `false` | `true`, `false` | `?hide_background=true` |
| `hide_stats` | `boolean` | No | `false` | `true`, `false` or `1` | `?hide_stats=true` |
| `tz` | `string` | No | UTC | Any IANA timezone e.g. `Asia/Kolkata`, `America/New_York` | `?tz=Asia/Kolkata` |
| `lang` | `string` | No | `en` | `en`, `es`, `hi`, `fr`, `pt`, `ko` | `?lang=hi` |
| `view` | `string` | No | `default` | `default`, `monthly` | `?view=monthly` |
| `delta_format` | `string` | No | `percent` | `percent`, `absolute`, `both` | `?delta_format=absolute` |
| `width` | `number` | No | `300` | Any positive integer (applies to `view=monthly` only) | `?width=400` |
| `height` | `number` | No | `120` | Any positive integer (applies to `view=monthly` only) | `?height=150` |

### Theme Presets

Expand Down
Loading