Turn any repository into production-grade documentation.
Stop wasting hours writing boilerplate documentation. ReadmeForge inspects your GitHub file tree, detects packages & languages, and generates structured, badge-rich READMEs in seconds.
# facebook/react
[](...) [](...)
> The library for web and native user interfaces.
## 🛠️ Built With
`TypeScript` • `JavaScript` • `React` • `Rollup` • `Jest`
## 🚀 Quick Start
$ git clone https://github.com/facebook/react.git
$ npm install && npm run build
Engineered for modern developers
Everything you need to give your open-source projects and repositories the documentation they deserve.
Deep Repository Intelligence
Inspects root file manifests, package.json, Cargo.toml, go.mod, and Docker configs to accurately detect your stack.
Dynamic Shields.io Badges
Automatically injects live shields for GitHub stars, forks, open issues, license status, and top technologies.
Dual Preview Mode
Switch seamlessly between live rendered HTML (with real GitHub typography) and syntax-highlighted raw markdown.
Customizable Style Presets
Choose from Modern Showcase, Clean Minimalist, or Comprehensive Enterprise styles with customizable sections.
One-Click Export
Instantly copy markdown directly to your clipboard or download the structured README.md file directly.
Database Archive
Persist and organize your documentation history in PostgreSQL with Prisma ORM for quick retrieval anytime.
From repo URL to README in seconds
A seamless 6-step flow designed to eliminate documentation friction forever.
Paste Repo URL
Simply drop your GitHub repository link or shorthand (e.g. vercel/next.js) into the forge input.
Deep Code Analysis
We fetch repository metadata, languages, root manifests, and detect your active framework stack.
Fine-tune & Style
Customize documentation tone, select your package manager (npm, pnpm, yarn, bun), and toggle sections.
Instant Generation
Click generate and receive a comprehensive, badge-adorned README crafted with precision.
Dual-Mode Inspection
Switch dynamically between rendered GitHub HTML preview and raw Markdown source code.
Export & Save
Copy to clipboard in one click, download the .md file, or save directly to your account database.