A visual, drag-and-drop builder for beautiful GitHub README files.
Stop wrestling with Markdown syntax. readme-forge gives you a clean block-based editor on the left and a live GitHub-flavored preview on the right.
- ✨ Block-Based Editing — build your README from 10 structured blocks: Title, Badges, Description, TOC, Features, Installation, Usage, Tech Stack, Contributing, License
- 🎨 Template Presets — start with pre-configured templates for CLI tools, React libraries, or APIs
- 🏷️ Smart Badges — add npm, license, downloads, and build status badges with one click
- 🛠️ Tech Stack Selector — choose from 13 popular technologies with auto-generated badges
- 🔄 Real-Time Preview — powered by
react-markdownto simulate exactly how GitHub renders your file - 🏗️ Drag to Reorder — rearrange sections with up/down buttons
- 💾 1-Click Export — copy raw Markdown to clipboard or download
README.mddirectly - 📋 Auto-Generated Content — TOC and Contributing sections generate automatically
git clone https://github.com/dinakars777/readme-forge
cd readme-forge
npm install
npm run devOpen http://localhost:5173 to start building.
| Tool | Purpose |
|---|---|
| React 19 + TypeScript | UI framework |
| Vite | Build tool & dev server |
react-markdown |
Live GitHub-flavored preview |
lucide-react |
Icons |
| Vanilla CSS | Styling |
- Badges block (shields.io integration)
- Contributing block
- License block
- Table of Contents auto-generation
- Template presets (CLI tool, React library, API)
- Drag-and-drop reordering
- Custom badge creator
- Export to multiple formats (HTML, PDF)
- Save/load projects from localStorage
MIT