The manual for building your profile monument.
Everything in the README, reshaped into a cleaner in-product guide so users can go from copy-paste embed to fully customized monolith without leaving the site.
Priority chain
Quick Start
Add the default badge in one line
Paste this snippet into any Markdown surface that supports remote images, including your GitHub profile README, a portfolio page, or internal docs.
Replace YOUR_USERNAME with your GitHub handle and the API will render the default dark theme automatically.
Live Examples
Common configurations you can ship immediately
These examples mirror the most useful README snippets, but in a format designed for fast scanning.
Default embed
snippetThe fastest way to drop the monolith into your profile README.
Neon theme
snippetSwap the default palette for the high-contrast cyberpunk preset.
Custom colors
snippetOverride the background, accent, and text colors directly with hex values.
Fresh data
snippetForce a cache bypass when you want the latest contribution state immediately.
Parameter Reference
Every URL knob, organized for implementation
All color parameters expect hex values without a leading #. When both a theme and manual colors are provided, the manual colors win.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| user | string | Yes | None | GitHub username to render. This is the only required parameter. |
| theme | string | No | dark | Preset palette name. Choose from dark, neon, dracula, github, or light. |
| bg | hex | No | Theme default | Background color without the # prefix. |
| accent | hex | No | Theme default | Tower, glow, and emphasis color without the # prefix. |
| text | hex | No | Theme default | Label and stat text color without the # prefix. |
| radius | number | No | 8 | Border radius in pixels for the generated SVG card. |
| refresh | boolean | No | false | Bypass the cache for real-time refreshes. |
Theme Gallery
Preset palettes for different moods
Use the theme parameter for fast styling, then override individual values only when you need a custom blend.
Dark
GitHub-dark default with calm blue highlights.
Neon
Pure black with magenta towers and cyan text.
Dracula
Purple-forward palette inspired by Dracula Pro.
GitHub
Deep GitHub green for a more native contribution feel.
Light
Bright, minimal surface for portfolios and white backgrounds.
Contributor Guidance
Technical context behind the public API
These notes come straight from the current implementation approach in the README and help contributors understand why the route behaves the way it does.
URL parameters override theme defaults, and theme defaults override the system fallback palette.
Contribution counts stay aligned with GitHub by syncing cache invalidation to UTC midnight boundaries.
The API layer bypasses internal fetch caching so HTTP cache headers stay the single source of truth.
Next Step
Need deeper project context?
The README still covers architecture, deployment, and contributor onboarding in more detail.
This page is the fast implementation manual. For self-hosting, architecture details, and repository-level contributor guidance, jump to the full source docs.