GitHub README 不会设计?这个 Skill 帮你重新做一遍
很多开源项目功能不错,README 却像一份说明书:开头就是安装命令、目录结构和参数列表。访客看了半天,仍然不知道项目解决什么问题。
beautify-github-readme 是一个专门改造 GitHub README 的 Agent Skill。它会先阅读真实仓库,找出项目价值、使用效果和最快上手路径,再重新组织内容和视觉,而不是直接套一张通用模板。
这个 Skill 提供两种模式:
- README mode:调整阅读顺序、文案层级、示例、Markdown 和完整视觉系统。
- SVG-only mode:只制作 Hero、章节标题、流程图或徽章,不修改原有 README。
它的思路是让 Markdown 继续承载说明、命令和链接,把视觉部分交给 GitHub 兼容的 SVG。这样既能拥有更醒目的项目首页,也不会把整篇 README 变成无法搜索、复制和维护的长图片。
安装命令如下:
bash
npx skills add oil-oil/beautify-github-readme
安装后,可以让 Codex、Claude Code 或其他支持 Skill 的 Agent 执行:
text
使用 beautify-github-readme 重新设计这个仓库的 README。
根据项目内容确定视觉风格,先给我本地预览,不要提交或发布。
如果只想加一个头图,可以明确限定范围:
text
只创建一个 SVG Hero,保持 README 文字和结构不变。
这个 Skill 比较值得肯定的一点,是它要求所有卖点、数据和示例都来自真实项目,并且修改前先确认模式,完成后先展示预览和差异,不会擅自提交、推送或发布。
如果你的项目功能已经写完,却总觉得 README 留不住人,可以用它整理一次项目首页。