A completely client-side, visual builder for incredibly beautiful GitHub-flavored
README.mdfiles.
Stop struggling with Markdown syntax. readme-forge uses a clean, startup-aesthetic document editor where you fill in form blocks on the left, and instantly see the perfectly rendered Markdown on the right.
- ✨ Block-Based Editing: visually construct your documentation using standardized blocks (Title, Description, Features, Installation).
- 🔄 Real-Time Preview: Powered by
react-markdownto exactly simulate how GitHub will render yourREADME. - 🏗️ Reorder Blocks: Easily drag, drop, and rearrange sections.
- 💾 1-Click Export: Copy the raw Markdown straight to your clipboard or instantly download the
README.mdfile.
- React + TypeScript
- Vite
- Vanilla CSS (
index.css&App.css) react-markdown
npm install
npm run devVisit the local server to start drafting perfect documentation visually.
MIT