Readme Studio is a free, browser‑based README.md builder for GitHub projects. It focuses on clean, best‑practice sections and produces a polished Markdown file with badges and optional sections based on what you actually fill in.
https://thisizasif.github.io/ReadmeStudio/
- Generates a production‑ready README.md from a simple form
- Shows a live preview and a separate Markdown view
- Builds badges automatically (repo, license, status, etc.)
- Includes or omits sections based on your input (no empty headings)
- Provides a FAQ builder with multiple Q/A entries
- Supports tech‑stack badge selection
- Live preview (rendered output)
- Markdown view with one‑click copy
- Tech stack badge picker
- Screenshot URLs section
- FAQ builder (add as many Q/A items as needed)
- Optional social badges section
- Table of Contents auto‑generated when enough sections exist
- Open the site.
- Fill in the fields that apply to your project.
- Click “Open Preview” to see the rendered README.
- Switch to “Show Markdown” and click “Copy Markdown”.
- Paste into your repository as
README.md.
- Only sections with content are rendered.
- Links in Demo/Repository/Contributing are rendered as badges.
- The Table of Contents appears automatically when there are enough sections.
index.html– UI layout and metadatastyle.css– visual theme and layoutscript.js– form logic, Markdown generation, preview renderingog-image.html/generate-images.py– social image assets
This is a static site. You can open index.html directly in a browser or serve it with any static server.
MIT License
thisizasif – https://github.com/thisizasif