convez.ai
SkillDesenvolvimento WebIntermediário
LaughingisLaughing

repo-beautify

LaughingisLaughing/repo-beautify

Embeleza repositórios GitHub com fatos verificados, sem badges falsos

Ver no GitHub
InicialPluginScore · de 0 a 100

Skill de agente que reformata a vitrine de repositórios GitHub com fatos verificados: redesign de README, badges autênticos, tópicos e prévia social. Garante que nenhuma informação seja fabricada, consultando sempre um registro de fatos extraído da estrutura real do projeto.

Instalação

$npx convez-ai LaughingisLaughing/repo-beautify

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
1
Forks
0
Acompanhando
0
Saúde
42%
Último commit
há 5 meses
Versão
—
Issues abertas
0
Contribuidores
1

Casos de uso

  • Reformatar README de projeto com múltiplos estilos à escolha
  • Validar e completar descrição, tópicos e metadados do GitHub
  • Auditar segurança antes de publicação em registros (npm, PyPI, etc)
  • Gerar previsualizações sociais e badges autênticas baseadas em dados reais

Veredito

Solução robusta e bem-arquitetada que resolve um problema real: embelezamento verificável de repositórios sem fabricação de dados. A abordagem em camadas (fatos → conteúdo → visuais) é sólida e o tooling integrado (scan, compare, audit) agrega valor real para mantenedores.

README

A tradução para o português deste README ainda está na fila.

Agent Skill Bash Python Claude Code Codex License: MIT


🧭 The Problem

Asking an AI agent to "make my README beautiful" usually produces a pretty page of lies:

npm install -g your-package        # ...that was never published to npm
[![Build](https://img.shields.io/badge/build-passing-green)]()   # ...with no CI configured
"⭐ Loved by thousands of developers"                             # ...at 0 stars

And the README is only half the storefront. The GitHub description, topics, social preview, and package manifest stay empty while everyone stares at the banner.

✨ The Fix

repo-beautify is an Agent Skill that beautifies in three layers, in order: facts, content, visuals. Every claim in the output must cite a "fact ledger" entry: the scan JSON, an existing file path, a command output, or a live API result.

flowchart LR
    S["🔍 scan_repo.sh<br/>fact ledger JSON"] --> C["🎨 choose style<br/>classic / visual /<br/>compare page"]
    C --> G["📝 generate README<br/>verified facts only"]
    G --> V["✅ validate<br/>badges · mermaid · installs"]
    V --> M["🏪 finish the storefront<br/>description · topics · manifest"]
    style S fill:#6366F1,color:#fff
    style M fill:#1e293b,color:#94a3b8

🚀 Quick Start

Install with the skills CLI:

npx skills add LaughingisLaughing/repo-beautify

Then ask your agent, in any words:

Beautify this repo's storefront with the repo-beautify skill. Scan the facts first, show me two README styles to choose from, and fix the GitHub description and topics too.

📦 What's Inside

FileRole
SKILL.mdThe workflow and the hard rules (fact ledger, no fabrication, docs must survive re-skinning)
scripts/scan_repo.shStorefront fact scanner: manifest gaps, license, registry publish status, GitHub description/topics, community files, demo assets
scripts/build_compare.pyRenders README variants side-by-side with GitHub CSS (mermaid + dark mode) so you pick a style in the browser
scripts/check_bilingual.pyParity checker for bilingual READMEs: code blocks, links, images, and heading counts must line up
scripts/publish_audit.pyPublish-safety audit: secrets, risky files, home paths, personal emails, across the tree and full git history
assets/template-classic.mdBest-README-Template lineage, contributor-oriented
assets/template-visual.mdHero banner, typing animation, badges, social card, mermaid, star history
assets/heroes/Ten self-hosted animated hero SVG templates (previews below)
references/visual-services.mdURL recipes and pitfalls for capsule-render, typing-svg, shields, socialify, star-history
references/readme-structure.mdSection order, per-project-type adaptation, content-merge rules
references/bilingual-readme.mdTranslation boundaries, tone, and validation flow for the Chinese edition
references/publish-safety.mdTriage guide for audit findings: rotate-then-purge, history rewrites, what not to fix

🎨 Hero Style Catalog

Ten self-hosted hero styles ship with this skill. Each is a ~2KB animated SVG: zero JS, zero third-party requests, readable from frame 0. Pick one by name when you run the skill ("use the bauhaus hero"). Templates live in assets/heroes/, the banners below are the live previews.

swiss · paper grid, extreme weight contrast, an accent square hopping between stations swiss hero preview

aurora · Linear-style dark gradient, three blurred blobs drifting on async clocks aurora hero preview

vignelli · oversized cropped wordmark, sweeping red rule, breathing period vignelli hero preview

orbit · terminal prompt with blinking cursor, satellites orbiting a source of truth orbit hero preview

blueprint · engineering drawing: construction grid, marching measurement line, rotating compass blueprint hero preview

brutalist · thick frame, hard-shadow type, an endless ticker strip brutalist hero preview

dotwave · LED dot matrix with a diagonal pulse wave dotwave hero preview

editorial · literary masthead: serif title, small caps, rotating ornament editorial hero preview

outline · stroke-only wordmark with a flowing color gradient outline hero preview

bauhaus · geometric primaries, an orbiting moon and a swaying triangle bauhaus hero preview

💬 Prompts You Can Paste

Use the repo-beautify skill on this repository. Run the fact scan, generate both README styles, build the comparison page, and after I pick one, apply it and fix the repo description, topics, and manifest fields.
Use repo-beautify to generate classic and visual README variants for this repo and open the comparison page. Do not change any files yet.
Use repo-beautify step 5 only: audit this repo's GitHub description, topics, manifest fields, releases, and community files, and fix what is missing. Leave the README alone.
Run the repo-beautify publish-safety audit on this repository, including git history. Triage every finding, tell me which ones are blockers, and walk me through fixing them before I make the repo public.

🛡️ Hard Rules

  1. Fact ledger: every claim cites the scan JSON, a file path, a command output, or an API result.
  2. Never fabricate: no badge or install command for anything that does not exist. unknown registry state means ask, not guess.
  3. Re-skinning never loses docs: old sections are inventoried and mapped, collapsed maybe, deleted never.
  4. Scale to the project: a 50-line script does not get a 300-line README.

📝 Notes

  • The visual style depends on third-party image services (capsule-render, shields, socialify, star-history). They are storefront flair; never encode load-bearing information only in a generated image.
  • Headless screenshots freeze SVG animations at frame 0; verify banners via curl | grep '<text', not screenshots.
  • GitHub caches README images through camo; expect propagation delay after URL changes.

⭐ Star History


MIT © LaughingisLaughing

Ver o original no GitHub

Bom para

Relacionados