github-readme-design
Lay out and render GitHub repository READMEs and public or member-only organization profiles from a supplied information set and the applicable DESIGN. Use for README first screens and section layout for libraries, CLIs, MCP servers, plugins and apps, open or closed source; badge styling; Quick look form; app download blocks and screenshot plans; public and member-only organization profile layout; deterministic catalog-driven profiles and social previews; and locally rendered light/dark terminal demos with CI recording checks. Produces README layouts, image exports, terminal scripts and recordings, catalog-driven social/profile exports and review evidence. Does not decide what a README states or source its values, change repository settings, upload previews, assign documentation roles, design icons, or build personal profile READMEs.
Pinned to revision 21a48e000156, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/github-readme-design/SKILL.md
- skills/github-readme-design/agents/openai.yaml
- skills/github-readme-design/evals/evals.json
- skills/github-readme-design/evals/files/closed-source-app.json
- skills/github-readme-design/evals/files/open-source-app.json
- skills/github-readme-design/references/architecture.md
- skills/github-readme-design/references/design-apps.md
- skills/github-readme-design/references/design.md
- skills/github-readme-design/references/eval-fixtures.md
- skills/github-readme-design/references/renderers.md
- skills/github-readme-design/scripts/.node-version
- skills/github-readme-design/scripts/action.yml
- skills/github-readme-design/scripts/package-lock.json
- skills/github-readme-design/scripts/package.json
- skills/github-readme-design/scripts/src/catalog.ts
- skills/github-readme-design/scripts/src/check.ts
- skills/github-readme-design/scripts/src/cli.ts
- skills/github-readme-design/scripts/src/design.ts
- skills/github-readme-design/scripts/src/fonts.ts
- skills/github-readme-design/scripts/src/profile/render.ts
- skills/github-readme-design/scripts/src/social-preview/allowlist.ts
- skills/github-readme-design/scripts/src/social-preview/icon.ts
- skills/github-readme-design/scripts/src/social-preview/raster.ts
- skills/github-readme-design/scripts/src/social-preview/render.ts
- skills/github-readme-design/scripts/src/terminal/record.ts
- skills/github-readme-design/scripts/src/terminal/render.ts
- skills/github-readme-design/scripts/src/validation.ts
- skills/github-readme-design/scripts/test/action.test.ts
- skills/github-readme-design/scripts/test/fixtures/DESIGN.md
- skills/github-readme-design/scripts/test/fixtures/executable.sh
- skills/github-readme-design/scripts/test/fixtures/fonts/GoogleSansCode[MONO,wght].ttf
- skills/github-readme-design/scripts/test/fixtures/fonts/OFL.txt
- skills/github-readme-design/scripts/test/fixtures/profile/catalog.json
- skills/github-readme-design/scripts/test/fixtures/profile/member.json
- skills/github-readme-design/scripts/test/fixtures/profile/member.md
- skills/github-readme-design/scripts/test/fixtures/profile/public.md
- skills/github-readme-design/scripts/test/fixtures/recording.json
- skills/github-readme-design/scripts/test/fixtures/session/fixture/note.txt
- skills/github-readme-design/scripts/test/fixtures/session/script.yml
- skills/github-readme-design/scripts/test/fixtures/social-preview/icon.jpeg
- skills/github-readme-design/scripts/test/fixtures/social-preview/icon.png
- skills/github-readme-design/scripts/test/fixtures/social-preview/icon.webp
- skills/github-readme-design/scripts/test/fixtures/social-preview/social-preview.png
- skills/github-readme-design/scripts/test/fixtures/terminal-dark.svg
- skills/github-readme-design/scripts/test/fixtures/terminal-light.svg
- skills/github-readme-design/scripts/test/helpers.ts
- skills/github-readme-design/scripts/test/profile.test.ts
- skills/github-readme-design/scripts/test/record.test.ts
- skills/github-readme-design/scripts/test/social.test.ts
- skills/github-readme-design/scripts/test/terminal.test.ts
- skills/github-readme-design/scripts/test/update-goldens.ts
- skills/github-readme-design/scripts/tsconfig.json
Every link opens the file at its source, pinned to the revision this page describes.