YuShenLiu06/PCHSystem / .claude/skills/beautify-github-readme
beautify-github-readme
VerifiedRedesign GitHub README homepages or create project-native pure SVG, hybrid SVG-composed PNG/WebP, and opt-in animated GIF assets. Use when a user asks to beautify, redesign, rebrand, visually upgrade, simplify, or audit a GitHub README; create only a hero, section headers, diagrams, badges, motion graphics, showcase modules, or other README assets; or turn a repository homepage into a cohesive visual story. If whole-README work versus asset-only work is unclear, ask which scope the user wants. For hero-like assets where pure SVG and generated raster material are both viable, explain the tradeoffs and confirm the implementation before creating the asset.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 16.0 KB |
| agents/openai.yaml | config | 328 B |
| references/content-architecture.md | markdown | 1.3 KB |
| references/github-readme-canvas.md | markdown | 3.3 KB |
| references/hybrid-svg-production.md | markdown | 4.5 KB |
| references/motion-production.md | markdown | 6.7 KB |
| references/project-native-hero.md | markdown | 5.9 KB |
| references/showcase-contribution.md | markdown | 2.5 KB |
| references/svg-production.md | markdown | 9.9 KB |
| references/visual-direction.md | markdown | 3.6 KB |
| scripts/audit_readme.pyexecutable | script | 2.7 KB |
| scripts/render_motion_gif.pyexecutable | script | 19.3 KB |
scripts/audit_readme.py
View on GitHub#!/usr/bin/env python3
"""Audit local README image references and basic SVG compatibility."""
from __future__ import annotations
import re
import sys
import xml.etree.ElementTree as ET
from pathlib import Path
MARKDOWN_IMAGE = re.compile(r"!\[[^\]]*\]\(([^)\s]+)(?:\s+[^)]*)?\)")
HTML_IMAGE = re.compile(r"<img\b[^>]*\bsrc=[\"']([^\"']+)[\"'][^>]*>", re.I)
HTML_ALT = re.compile(r"\balt=[\"']([^\"']*)[\"']", re.I)
UNSAFE_SVG_TAGS = {"script", "foreignObject"}
def local_target(src: str, base: Path) -> Path | None:
if src.startswith(("http://", "https://", "data:", "#")):
return None
clean = src.split("#", 1)[0].split("?", 1)[0]
return (base / clean).resolve()
def audit_svg(path: Path) -> list[str]:
issues: list[str] = []
try:
root = ET.parse(path).getroot()
except ET.ParseError as exc:
return [f"invalid SVG XML: {exc}"]
if "viewBox" not in root.attrib:
issues.append("missing viewBox")
title_found = False
for node in root.iter():
tag = node.tag.rsplit("}", 1)[-1]
if tag == "title":
title_found = True
if tag in UNSAFE_SVG_TAGS:
issues.append(f"contains unsupported <{tag}>")
if not title_found:
issues.append("missing <title>")
return issues
def main() -> int:
if len(sys.argv) != 2:
print("usage: audit_readme.py /path/to/README.md", file=sys.stderr)
return 2
readme = Path(sys.argv[1]).expanduser().resolve()
if not readme.is_file():
print(f"ERROR: README not found: {readme}")
return 2
text = readme.read_text(encoding="utf-8")
sources = MARKDOWN_IMAGE.findall(text)
html_tags = re.findall(r"<img\b[^>]*>", text, flags=re.I)
sources.extend(HTML_IMAGE.findall(text))
warnings: list[str] = []
for tag in html_tags:
match = HTML_ALT.search(tag)
if not match or not match.group(1).strip():
warnings.append(f"HTML image missing useful alt text: {tag[:100]}")
checked = 0
for src in dict.fromkeys(sources):
target = local_target(src, readme.parent)
if target is None:
continue
checked += 1
if not target.is_file():
warnings.append(f"missing image: {src}")
continue
if target.suffix.lower() == ".svg":
for issue in audit_svg(target):
warnings.append(f"{src}: {issue}")
print(f"README: {readme}")
print(f"Local images checked: {checked}")
if warnings:
print("Issues:")
for warning in warnings:
print(f"- {warning}")
return 1
print("OK: image references and SVG basics passed")
return 0
if __name__ == "__main__":
raise SystemExit(main())
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 470k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 470k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 470k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |