Skip to content

Repository files navigation

AI Idea Card

Show the reusable intelligence inside any GitHub repository.

Generate beautiful SVG cards for AI skills, prompts, agents, and evals—ready to embed in a GitHub profile or project README.

Live generator · API · Manifest · Themes

Why

AI repositories contain much more than source code. They package agent skills, system prompts, reusable agents, evaluations, benchmarks, and other ideas that are difficult to see from the standard GitHub language card.

AI Idea Card scans those assets and turns them into one compact, living SVG.

Quick start

After deploying the app, add this Markdown to a README:

[![AI Idea Card](https://github-profile-card-ai-idea.vercel.app/api/card/OWNER/REPOSITORY?theme=neural)](https://github.com/OWNER/REPOSITORY)

Replace OWNER and REPOSITORY with a public GitHub repository.

What it detects

The default convention scanner recognizes:

  • Skills: files named SKILL.md
  • Prompts: content files in prompt/ or prompts/, plus *.prompt.md
  • Agents: content files in common agent directories, plus *.agent.md
  • Evals: content files in eval, evaluation, or benchmark directories

For custom layouts, add an explicit manifest.

Optional manifest

Create .github/ai-idea-card.yml in the repository being displayed:

version: 1
idea: Reusable AI workflows for turning rough ideas into tested agents.

tags:
  - Agent Skills
  - Prompts
  - Evals

compatibility:
  - Codex
  - Claude Code
  - GitHub Copilot

assets:
  skills:
    - "skills/**/SKILL.md"
  prompts:
    - "prompts/**/*.md"
  agents:
    - "agents/**/*.{md,yml,yaml,json}"
  evals:
    - "evals/**/*.{md,yml,yaml,json}"

Manifest patterns override automatic detection for that asset category. See the complete example manifest.

The MANIFEST badge means the configuration was found and parsed successfully. It is not a subjective quality certification.

API

GET /api/card/:owner/:repository?theme=neural

Themes

Value Description
neural Violet, cyan, and mint on a dark surface (default)
midnight Focused blue and teal dark theme
light High-contrast light theme

Successful cards are cached at the CDN for one hour and can be served stale while data refreshes. Error SVGs are marked no-store so API failures are not treated as valid long-lived cards.

Local development

Requirements: Node.js 22 or newer.

npm install
npm run dev

Open http://localhost:3000.

The app works without credentials for public repositories. For higher GitHub API limits, copy .env.example to .env.local and set a server-side token:

GITHUB_TOKEN=your_token

Never expose this token in a card URL or client-side variable.

Verify

npm run typecheck
npm test
npm run build

Deploy to Vercel

  1. Import this repository into Vercel.
  2. Optionally add GITHUB_TOKEN as an encrypted environment variable.
  3. If the deployment uses a different domain, set NEXT_PUBLIC_SITE_URL to its canonical URL.
  4. Deploy with the Next.js preset.

Roadmap

  • Repository asset detail cards
  • More themes and layout sizes
  • GitHub App authentication for reliable public hosting
  • Schema validation and manifest diagnostics
  • Organization and profile-level aggregate cards
  • Community theme gallery

Security and privacy

  • Only public GitHub repository data is rendered.
  • Owner and repository route parameters are strictly validated.
  • All untrusted repository text is XML escaped.
  • GitHub tokens remain server-side and are never rendered into SVG output.
  • The service only calls fixed GitHub API endpoints; repository input cannot choose an arbitrary upstream host.

License

MIT

About

Generate beautiful SVG cards that showcase the AI skills, prompts, agents, and evals inside any GitHub repository.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages