beautify-github-readme skill
An agent skill that redesigns a repository README and builds a hero, diagrams and SVG assets from the project itself
- 1,960 ★ on the repository
- Last commit
- MIT
Extended access
Why this level
- Reads the repository and creates files
- Runs render scripts and may connect image generation
Install
- Works in
In your terminal, with SkillFoxx CLI
npx skillfoxx add skills/beautify-github-readmeDetects the agents on your machine, shows the access level and pins the version.
Other ways to install
Access and checks
How we reviewExtended accessThe tool runs code or makes network calls and only reads external data.
- Reads the repository and creates files
- Runs render scripts and may connect image generation
This is third-party code. Review the repository files before installing.
What it does
The skill reads the repository and rebuilds the README so a visitor grasps the project's value, proof and setup at a glance. It runs in two modes: a full README pass or asset-only work such as a hero, section headers, diagrams and badges. The visual layer is deterministic SVG, with optional raster or generated imagery, and GIF motion only on an explicit opt-in. It never commits or publishes without approval and shows a local preview first.
Who it is for. For developers, designers and project owners who want a clear, well-structured README.
Good fit when
- You want to redesign a project README around its real theme
- You need only a hero, a diagram or a set of README SVG assets
- You want a read-only audit of a README for clarity and order
Not a fit when
- You want a plain text README without visual design
- You cannot run render scripts or connect image generation
Example request
Redesign this repository README around the project theme, show a local preview first and do not publish anythingLimitations
Markdown and SVG need no keys; PNG, WebP and generated art require your own render and image tools. The skill does not invent metrics or endorsements and works from the repository's real facts. Commits, pushes and publishing always need explicit approval.
How to disable. Remove the skill folder from your agent's skills directory, for example ~/.claude/skills/beautify-github-readme.
FAQ
Will it push changes to my repository?
No. It prepares a preview and a diff; commits, pushes and publishing happen only after you explicitly approve.
Discussion
No questions or reviews yet.
Related
SkillsA Claude Code skill that draws interactive isometric biology figures from a description: toggled mechanisms, sourced numbers
A WeChat article layout skill: turns Markdown into paste-ready HTML with inlined styles that survives pasting into the official account editor
Skill suite for Codex that carries an idea to a finished proposal deck: strategy, manuscript, visuals, review and delivery.
A de-AI writing skill: it repairs the narrative architecture of fiction and edits professional documents by their venue rules
106 social media skills: strategy, posts, video, design, platform growth and scheduled publishing only on your explicit go.
A collection of open Agent Skills by Huashu for content work: slides, design, data processing, video scripts and text proofreading
README in short
The README is itself a demo: a themed hero, a style wall, real cases and SVG section transitions. The skill separates layers: SVG for visuals, Markdown for text and commands, GIF for optional motion. It ships two modes, reference guides for SVG and hero production, plus audit and render scripts. It installs via npx skills add or by asking your agent. MIT licensed.
README badge
Original SKILL.md
--- name: beautify-github-readme description: Redesign 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. --- # Beautify GitHub README Turn a repository homepage or requested visual asset into a concise, theme-specific visual story. Treat Markdown as the content layer, deterministic SVG as the layout system, and generated raster material as an optional visual ingredient. ## Workflow ### 1. Confirm the mode before editing Use exactly one execution mode: - README mode: improve the whole README, information order, copy hierarchy, proof, Markdown, and visual system. - Asset-only mode: create only the requested static SVG or visual asset set. Static SVG is the default.