{"id":50854443,"url":"https://github.com/geekjourneyx/readme-generator","last_synced_at":"2026-06-14T17:05:51.875Z","repository":{"id":352666769,"uuid":"1216102513","full_name":"geekjourneyx/readme-generator","owner":"geekjourneyx","description":"Generate professional README.md with 16:9 infographics, SEO-optimized metadata, and structured author sections — powered by Playwright and AI agent skills","archived":false,"fork":false,"pushed_at":"2026-04-20T15:34:18.000Z","size":1755,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-20T17:36:42.252Z","etag":null,"topics":["agent-skills","claude-code","claude-skills","copilot-cli","developer-tools","playwright","readme-generator","skills"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/geekjourneyx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-20T15:11:28.000Z","updated_at":"2026-04-20T15:53:20.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/geekjourneyx/readme-generator","commit_stats":null,"previous_names":["geekjourneyx/readme-generator"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/geekjourneyx/readme-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekjourneyx%2Freadme-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekjourneyx%2Freadme-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekjourneyx%2Freadme-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekjourneyx%2Freadme-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geekjourneyx","download_url":"https://codeload.github.com/geekjourneyx/readme-generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geekjourneyx%2Freadme-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34329769,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-14T02:00:07.365Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent-skills","claude-code","claude-skills","copilot-cli","developer-tools","playwright","readme-generator","skills"],"created_at":"2026-06-14T17:05:51.397Z","updated_at":"2026-06-14T17:05:51.867Z","avatar_url":"https://github.com/geekjourneyx.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# GitHub README Generator\n\n**把项目 README 做成一份可以展示的作品。**\n\n\u003cimg src=\"assets/banner.webp\" alt=\"GitHub README Generator — portfolio-grade README design for open source projects\" width=\"100%\"\u003e\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)\n[![Node](https://img.shields.io/badge/Node.js-≥18-6b7c5e.svg)](https://nodejs.org)\n[![Skill](https://img.shields.io/badge/Codex_Skill-README_Design-c96442.svg)](#快速开始)\n\n\u003c/div\u003e\n\n---\n\n## 这是什么\n\nGitHub README Generator 是一个 Agent Skill，用来把普通项目 README 升级成作品集级项目首页。\n\n它不会只替你填模板，而是先阅读项目，提炼背景、价值和使用路径，再生成克制的文案、作品级视觉资产和 GitHub 元信息建议。\n\n---\n\n## 为什么需要它\n\nGitHub 项目就是开发者的作品集。README 是读者、招聘者、用户和 AI 搜索首先看到的页面。\n\n很多项目明明有价值，却被冗长说明、小字截图、过度装饰和模板化功能列表削弱了第一印象。这个 Skill 的目标是反过来做：少说废话，放大重点，让项目自己的故事站出来。\n\n---\n\n## 你会得到什么\n\n\u003cimg src=\"assets/features.webp\" alt=\"Three outcomes: story, visual identity, and clean delivery\" width=\"100%\"\u003e\n\n---\n\n## 工作方式\n\n它先阅读项目，判断 README 应该是偏作品展示还是偏清晰文档；再提炼项目故事，生成正文、两张以内的视觉资产和 GitHub 元信息建议。\n\n---\n\n## 快速开始\n\n安装后，在 Codex 中打开你的项目目录，然后直接说：\n\n```text\n帮我把这个项目的 README 做成作品集级项目首页\n```\n\n也可以指定视觉方式：\n\n```text\n用 Codex Image Gen 生成 README 封面，其余保持清晰信息图\n```\n\n```text\n生成一个极简文档型 README，不要重视觉\n```\n\n---\n\n## 安装\n\n```bash\nnpx skills add https://github.com/geekjourneyx/readme-generator\n```\n\n如果需要使用 HTML 模板截图生成图片，请确认本地有 Node.js 和 Playwright：\n\n```bash\nnode -v\nnpm install\nnpx playwright install chromium\n```\n\n---\n\n## 视觉模式\n\n| 模式 | 适合项目 | 图片策略 |\n|------|----------|----------|\n| `portfolio` | 默认推荐，多数开源项目 | 封面可用 Codex Image Gen，说明图用大字海报 |\n| `clean-doc` | SDK、库、后端工具 | 少图，优先快速开始和示例 |\n| `visual-story` | AI 工具、设计工具、独立产品 | 更强视觉叙事和封面表现 |\n| `structured` | 需要流程、能力、对比图 | HTML/CSS 模板截图，保证文字准确 |\n\n---\n\n## 生成内容\n\n```text\nproject/\n├── README.md\n├── LICENSE\n└── assets/\n    ├── banner.webp\n    └── features.webp\n```\n\n图片可以来自两条路线：\n\n- Codex Image Gen：适合封面、氛围图、作品集视觉。\n- HTML 截图模板：适合功能、流程、对比等需要文字准确的图。\n\n---\n\n## 设计标准\n\n这个 Skill 按 100 分 README 标准工作：\n\n| 维度 | 分值 |\n|------|------|\n| 15 秒理解项目价值 | 25 |\n| 讲清项目故事 | 20 |\n| 视觉像作品而不是说明书 | 20 |\n| 快速开始足够直接 | 15 |\n| 有可信产物展示 | 10 |\n| 克制、少噪音、不过度设计 | 10 |\n\n---\n\n## 许可证\n\n[MIT](./LICENSE)\n\n---\n\n## 关于作者\n\n| | |\n|:---|:---|\n| 个人主页 | [geekjourney.dev](https://geekjourney.dev) |\n| GitHub | [geekjourneyx](https://github.com/geekjourneyx) |\n| Twitter | [@seekjourney](https://x.com/seekjourney) |\n| 公众号 | 微信搜「极客杰尼」 |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeekjourneyx%2Freadme-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeekjourneyx%2Freadme-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeekjourneyx%2Freadme-generator/lists"}