README Generator
Answer some questions, get a README that doesn't look generated.
BeginnerWeb appDev tool6–14hAI-buildable 5/5no setupworth shipping
Build a project README from structured input with a live markdown preview. Section ordering, badge generation and a table of contents that updates itself. It's the tool you'd reach for at the start of every one of these projects.
UI
Logic
Useful
Hosting · Free forever
Deploys free on GitHub Pages, Cloudflare Pages or Vercel Hobby.
Deploy it and share a link.
Core features · 7
- Form sections for description, install, usage, licence and contributing
- Sections can be toggled on and reordered by drag
- Live markdown preview beside the form
- A table of contents generates from the enabled sections
- Shields.io badges are generated from the project details
- Copy the markdown or download it as a file
- The document persists across reloads
The interesting part
- Generating anchor links that match GitHub's heading slug rules
- Reordering sections without losing entered content
- Escaping user text so it can't break the markdown structure
Once it works
- Prefill from a GitHub repository URL
- Add template presets for library versus application
- Add a live rendered preview matching GitHub's styling
Suggested stack
reacttypescripttailwindreact-markdowndnd-kit