输入公开 GitHub 仓库 URL,服务端代理 GitHub REST API 抓取元数据、递归文件树与清单文件
Readme-Forge — Next.js 工具站模板
作者 DarkFeed2005
输入 GitHub 仓库地址,经服务端抓取元数据与文件树后调用 OpenRouter 上的 Llama 3.3 70B 流式生成 README,支持自定义模板。
看看你的网站会是什么样
浏览真实页面截图,比较内容排版与手机效果。点击下方缩略图切换,放大查看整页细节。
全部页面与视图 2
截图用于了解视觉与布局,交互效果请以实际项目为准。
值得关注的模板亮点
从已有项目资料中,快速了解它的特点。
通过 OpenRouter 调用 Llama 3.3 70B,以流式响应边生成边在右侧预览
内置默认模板,并支持带 {{placeholders}} 占位符的自定义模板结构
react-markdown + remark-gfm 渲染,生成完成后可复制或下载 README.md
OpenRouter Key 默认由服务端 .env.local 保管,也支持页面临时覆盖且不落盘
模板详细介绍
Readme-Forge 是一个把 GitHub 仓库地址转成 README.md 的生成工具,前端用 Next.js App Router、TypeScript 和 Tailwind CSS 搭建,界面是左右分栏:左侧填仓库 URL 和模板,右侧用 react-markdown 加 remark-gfm 实时渲染流式返回的 Markdown。它自己不做仓库解析,而是通过 /api/github 代理 GitHub REST API,读取仓库元数据、递归文件树和关键清单文件,顺带做技术栈识别。
生成环节交给 OpenRouter 上的 meta-llama/llama-3.3-70b-instruct,服务端以 SSE 方式把补全结果推回浏览器,边生成边预览。模板系统是它比较有辨识度的部分:内置一份默认模板,也支持带 {{placeholders}} 占位符的自定义结构,仓库上下文和模板一起作为提示词输入。API Key 默认放在 .env.local 由服务端保管,也允许在页面上临时覆盖,且只用于当次请求。
需要留意的是,README 明确说明不做持久化,仓库数据和生成结果只存在于当前会话内存中,刷新即丢;/api/github 只访问公开 GitHub REST API,私有仓库不在支持范围内。另外仓库文件里能看到未清理的 Git 冲突标记(<<<<<<<、>>>>>>>),项目结构段落因此有些混乱,实际目录以 src 下的 app、components、lib 为准。License 一栏在资料中标记为待核实,README 正文写的是 MIT,使用前建议自行确认。
适合想快速给公开仓库补一份结构完整 README 的开发者,或者想研究 Next.js 流式 AI 接口与 Markdown 实时预览怎么配合的人。如果项目需要私有仓库、批量处理或生成结果留档,这个模板目前不覆盖这些场景。
适合你的项目吗?
适用场景
- 为已有公开仓库快速生成一份结构完整的 README 初稿
- 把团队惯用的 README 结构写成模板,批量套用到不同仓库
- 学习 Next.js App Router 下 SSE 流式接口与 Markdown 实时预览的配合方式
适合人群
- 需要给公开仓库补文档的个人开发者或小团队
- 愿意自行申请并配置 OpenRouter API Key 的使用者
- 想参考或二次开发这套生成流程的前端开发者
上手与定制指南
结合仓库当前版本的说明,按下面的资料检查内容、配置与运行要求。
- 1
需要 Node.js 环境,克隆后安装依赖并复制 .env.example 为 .env.local,填入 OPENROUTER_API_KEY
- 2
README 中安装命令同时出现 pnpm install 与 npm install,使用前请以实际包管理器为准
- 3
仅支持公开仓库,私有仓库与需要鉴权的仓库不在当前实现范围内
- 4
生成结果不做持久化,刷新页面即丢失,需要自行复制或下载保存
- 5
仓库内存在未清理的 Git 冲突标记,项目结构说明与实际目录有出入,建议以 src 目录为准
授权与来源资料
使用条件与限制
免费使用 · 保留许可声明MIT许可,允许免费使用、修改、分发与商用,仅需保留版权和许可声明。
使用时需要遵守
- 保留原作者版权声明和 MIT 许可证声明。
- 保留版权声明与许可声明于所有副本或实质部分
额外费用与待核对事项
- README未说明第三方依赖或素材的授权范围
查看原文依据
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
许可证原文
Readme-Forge is licensed under the MIT License.
README 原文
https://github.com/DarkFeed2005/Readme-Forge/blob/main/LICENSEhttps://github.com/DarkFeed2005/Readme-Forge/blob/HEAD/README.mdPermission is hereby granted, free of char
许可证原文
DeepSeek 根据仓库许可证和 README 整理 ·2026-09-24。结果仅覆盖已读取资料,依赖、图片、字体及后续条款变更以各自原文为准。
项目核对记录与介绍依据
模板资料
- 来源平台
- GitHub
- 资料与维护参考分
- 资料较完整 · 79 / 100
- 技术栈
- Next.js · React
- 网站类型
- 工具站 · 文档
这个分数如何计算
本站按许可资料(最高30分)、演示链接(12分)、预览图(10分)、Star数(15分)、记录的维护时间(15分)、描述完整度(8分)、功能记录(5分)和分类资料(5分)计算。它不是代码、安全或性能测试,也不是 Google 评分;有链接不代表已实测可用。
这个项目需要核对什么
- 记录的仓库更新时间
- 2026-08-20
- 截图检查日期
- 2026-09-07
已收录演示链接。请用你的内容与屏幕尺寸检查;有演示不代表表单、认证或支付已经可用。
目录记录的主要技术栈是 Next.js。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料,不代表代码审计或部署实测。
查看具体选型方法 →介绍的制作与核对状态
介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。
当前版本没有可核对的编辑审核记录;旧的应用时间不代表已完成事实审核。
这条历史介绍未保存固定版本的来源快照。请对照当前仓库,发现不一致可反馈。
反馈内容错误看看同类模板
对比同技术栈与用途的模板,找到更适合的视觉与内容结构。

full-stack-ai-agent-template
Full-stack AI app generator — FastAPI + Next.js with AI Agents, RAG, streaming, auth, and 20+ integrations out…
Next.js · 工具站

tiktokenizer
tiktokenizer 是一个开源的在线工具站项目,核心功能是计算文本对应的 token 数量,服务于 openai/tiktoken 库。
Next.js · 工具站

resume builder
resume builder 是一个开源的在线简历生成工具,演示站点可直接体验。 它基于 Next.js、TypeScript 和 Material UI 构建,前端状态管理采用 Zustand,整体界面简洁,交互流畅。
Next.js · 工具站

picprose
PicProse 是一个开源的封面图生成工具,专为博客作者、内容创作者和开发者设计。 它通过直观的界面,让用户快速为 Medium、YouTube、B站等平台生成专业封面。
Next.js · 工具站

nextjs-prisma-boilerplate
nemanjam/nextjs-prisma-boilerplate 是一个面向中小型全栈应用的生产级启动器,围绕 Next.js 12、React 18、Prisma 4 和 Postgres 构建。
Next.js · 文档

notty
Notty 是一个定位明确的笔记应用模板,核心卖点是“离线优先 + 实时协作 + 数据自主”。
Next.js · 工具站
