Deterministic SVG instrumentation for GitHub READMEs and profiles.
Pure Python standard library engine. Generates standalone vector graphics that survive GitHub Camo proxy caching, adapt to Dark and Light modes via embedded media queries, and compile via markdown directives or local CLI.
GitHub README Simulator
Switch architectural color palettes and GitHub display modes to inspect real vector asset rendering across themes.
Directive Inspector & Builder (16 Elements)
Explore all 16 atomic components in the design system. Review dimensions, inspect themes, and copy production directives.
Master Header Banner
Flagship full-width repository header with radar sweep telemetry, 3-level technical specifications, and status badge.
| Parameter | Type | Default | Description |
|---|
Why Standalone SVGs Outperform Web Badges
Built from first principles to survive GitHub CDN caching mechanics and eliminate third-party API dependencies.
GitHub Camo Proxy Immunity
GitHub proxies external images through camo.githubusercontent.com with aggressive cache headers. Dynamic API badges fail when upstream APIs rate-limit or timeout. Pixel Readme Kit compiles assets into your repository and appends deterministic SHA-256 hashes (?v=<hash>) during build.
Single-File CSS Media Queries
Each SVG includes embedded CSS @media (prefers-color-scheme: dark) rules. A single vector file shifts foreground contrast, grid visibility, and panel transparency when the user toggles between GitHub Dark and Light themes.
Pure Python Stdlib (<40ms)
No Node.js, no Chromium binaries, no Cairo graphics bindings. The compiler runs on any standard Python 3.8+ installation with zero pip dependencies, making it instantaneous inside GitHub Actions CI runners.
Model Context Protocol (MCP)
Pixel Readme Kit ships with an integrated MCP server for Claude Code, Cursor, and Antigravity. AI coding assistants discover, scaffold, and recompile repository documentation autonomously without manual CLI steps.
Automated Scheduled Sync (GitHub Actions)
Keep star growth trajectories, issue counters, and contributor telemetry fresh on a daily cron without external webhooks:
name: Sync README Telemetry
on:
schedule:
- cron: '0 0 * * *' # Midnight UTC
workflow_dispatch:
jobs:
telemetry-sync:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Recompile README with Live Stats
run: |
python -m generator.cli sync --fetch-github --bust-cache --clean-assets
- uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "chore(readme): sync live github stars & telemetry [skip ci]"