readme-assets
Standardizes README image assets for packages that must render on GitHub, npm, and pi.dev. Use when adding, converting, optimizing, moving, or linking README assets, screenshots, GIFs, diagrams, or images in Markdown package docs.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 6
- Forks
- 0
01 前言 Front Matter
- name
- readme-assets
- description
- Standardizes README image assets for packages that must render on GitHub, npm, and pi.dev. Use when adding, converting, optimizing, moving, or linking README assets, screenshots, GIFs, diagrams, or images in Markdown package docs.
03 SKILL.md 正文
README Assets
Defaults
- Use WebP for screenshots and static README images unless animation or transparency needs another format.
- Store package images under
packages/<package>/assets/. - Use absolute raw GitHub URLs, not relative paths, so images render on GitHub, npm, and pi.dev.
- Use descriptive alt text.
URL format

Workflow
- Put images in the package
assets/directory. - Convert PNG/JPEG screenshots to
.webpwithcwebpwhen available. - Update README links to the raw GitHub URL format above.
- Remove superseded image files only when the README no longer references them.
- Verify no stale image references remain:
rg -n "assets/.*\.(png|jpg|jpeg)|images/|\.png|\.jpg|\.jpeg" README.md packages/*/README.md
Optimization
- Prefer the default
cwebpoutput first. It is usually enough for terminal or UI screenshots. - If files remain large, try
cwebp -m 6 -q 75 input.png -o output.webpand compare visual quality before replacing. - Do not over-optimize small screenshots for marginal savings.
Compatibility notes
- GitHub READMEs support relative paths, but npm and pi.dev may not preserve the same repository context.
- Raw GitHub URLs are the safest shared format across GitHub, npm, and pi.dev.
04 同仓库更多 Skills
impeccable
Use when the user wants to design, redesign, shape, critique, audit, polish, simplify, harden, animate, or otherwise improve a frontend interface: websites, landing pages, dashboards, product UI, components, forms, settings, onboarding, empty states, and native iOS or Android screens. Handles UX review, hierarchy, layout, typography, color, motion, UX copy, accessibility, responsive behavior, edge cases, and capturing or documenting design systems (DESIGN.md, tokens). Also for making bland UI bolder, loud UI quieter, or ambitious visual effects. Not for backend-only or non-UI tasks.
creating-changesets
Creates non-interactive Changesets release notes for this monorepo. Use when asked to add, write, create, or prepare changesets for package changes, especially instead of running `bun changeset` manually.