Prettier Profile

GitHub profile cards that look like they belong to a component library. A daily GitHub Action renders them to SVG, so they work in any README.md.

Docs · Try it with your @ · Configuration

3 months

All time

Components

Component
Profile header Avatar, name, one line, three counters
Activity arrow ◼ new repo · ◆ fork · ★ star above the line, commits below. 30d · 3m · 12m · all
Coding type An archetype like Daylight Sprinter from commit hours, rhythm and breadth, with the numbers behind it
Curiosity What you star, grouped into interests month by month; the last 90 days highlighted
Project card Screenshot or dotted cover, two lines, domain
Collected Masonry gallery of references, video stills marked

Every card follows GitHub's light or dark theme.

Quick start

1. Copy .github/workflows/cards.yml into any repo you own, or use the action directly:

   - uses: in-c0/my-prettier-github-profile-readme@main
     with:
       config: profile.config.json

2. Add a profile.config.json:

   {
     "username": "your-username",
     "activity": { "range": "12m" },
     "projects": [{ "id": "app", "title": "My App", "summary": "One line.", "url": "https://my.app" }]
   }

3. Paste dist/README-snippet.md from the output branch into your profile README.

Private activity is optional: set "activity": { "private": true } and add a personal access token as the PROFILE_TOKEN secret. Private repos show up as counts only, never names.

Develop

npm test               # renderer tests
npm run build:sample   # render dist/ from sample data, no network
npm run dev            # docs at http://localhost:8080

MIT