README美化skill

自动推荐演示展示了项目分析、版式建议和实际产出的文件。
Highlights
产品亮点
01
从仓库内容出发
根据项目类型、代码和已有素材判断适合的文档结构。
02
三种内置风格
瑞士网格适合文档,霓虹终端突出命令与输出,编辑海报突出产品视觉。
03
交付正文与视觉素材
可一起改写 Markdown 和制作深浅色 SVG 封面,也可单独生成章节图或流程图。
04
检查 GitHub 显示效果
用脚本检查 SVG 的 GitHub 兼容性,并生成桌面和移动端预览。
开源项目SDK 与库命令行工具产品文档
Capabilities
能做什么
自动推荐
- 输入
- 一个已有仓库
- 返回结果
- 基于项目内容推荐版式,并预览改版后的 README。
多方案对比
- 输入
- 尚未确定视觉方向的项目
- 返回结果
- 三个不同版式的封面预览。
指定风格
- 输入
- 已有风格偏好或品牌规范
- 返回结果
- 遵循指定风格的 README 或视觉素材。
Usage
这样跟 Agent 说
改版整个 README
用 beauty-readme 改版这个仓库的 README。先分析项目并推荐风格,再给我看本地预览。
比较不同风格
给这个项目做三个不同方向的封面预览,说明每种风格适合突出什么。
只制作封面
用 beauty-readme 给这个项目做一套深浅色封面,保留现有 README 正文。
Install
安装与配置
01
检出项目
仓库需要访问权限。取得权限后,在终端检出项目并进入项目目录。
git clone https://github.com/byteee-com/beauty-readme-skill.git
cd beauty-readme-skill02
安装到 Codex
将技能文件复制到 Codex 的个人技能目录。辅助脚本需要 Python 3.9 或更新版本。
mkdir -p ~/.codex/skills/beauty-readme
cp -R SKILL.md references scripts skeletons styles ~/.codex/skills/beauty-readme/03
安装到 Claude Code
也可以安装到 Claude Code 的个人技能目录。安装后,在要改版的仓库中用上面的示例开始。
mkdir -p ~/.claude/skills/beauty-readme
cp -R SKILL.md references scripts skeletons styles ~/.claude/skills/beauty-readme/




