Skip to content

dinakars777/readme-forge

Repository files navigation

readme-forge 🧰

A completely client-side, visual builder for incredibly beautiful GitHub-flavored README.md files.

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.

Features

  • Block-Based Editing: visually construct your documentation using standardized blocks (Title, Description, Features, Installation).
  • 🔄 Real-Time Preview: Powered by react-markdown to exactly simulate how GitHub will render your README.
  • 🏗️ Reorder Blocks: Easily drag, drop, and rearrange sections.
  • 💾 1-Click Export: Copy the raw Markdown straight to your clipboard or instantly download the README.md file.

Tech Stack

  • React + TypeScript
  • Vite
  • Vanilla CSS (index.css & App.css)
  • react-markdown

Development

npm install
npm run dev

Visit the local server to start drafting perfect documentation visually.

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages