Overview Version History Q & A Rating & Review
ReadmeCraft: Open-Source README & Badges Studio Pro 📝
Complete open-source README generator, Shields.io badge builder, and Markdown Table of Contents generator built directly into Visual Studio Code.
✨ Features
🚀 1-Click Open-Source README Generator: Automatically scans package.json, Git repository metadata, and LICENSE to generate a battle-tested, professional GitHub README.
🛡️ Visual Shields.io Badge Studio: Search, customize, and insert 30+ preconfigured badges (License, Version, Build passing, NPM downloads, Discord, Sponsors, TypeScript, Docker).
📑 Automatic Table of Contents (TOC): Parses markdown headings (##, ###) and creates clickable, anchor-linked TOC lists with proper indentation.
🎨 Interactive Badge Catalog: Live preview of rendered SVGs with 1-click insert directly into your open markdown documentation.
🛠️ Usage
1. Generate Open-Source README
Press Ctrl+Shift+P (or Cmd+Shift+P on macOS) and run:
ReadmeCraft: Generate Open-Source README.md Template...
2. Open Shields.io Badge Studio
Run ReadmeCraft: Open Shields.io Badge Studio to browse, customize, and insert badges into your documentation.
3. Insert Table of Contents
Open any markdown file and run:
ReadmeCraft: Insert Markdown Table of Contents (TOC)
⚙️ Configuration
Setting
Type
Default
Description
readmecraft.badgeStyle
string
"flat"
Visual style for generated Shields.io badges (flat, flat-square, for-the-badge).
If you find ReadmeCraft helpful, please consider sponsoring development:
👉 Sponsor Pirapaakaran on GitHub
Connect on LinkedIn: Pirapaakaran Pirathapan
📄 License
MIT © Pirapaakaran Pirathapan