Skip to content

Mayur-Pagote/README_Design_Kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

953 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
README Design Kit Logo

✨ Craft Beautiful Documentation in Minutes

Contributors Forks GitHub Stars Issues Pull Requests

About

README Design Kit is your all-in-one solution for creating professional, accessible, and visually appealing documentation. This curated collection of templates, components, and AI-powered tools eliminates the guesswork from writing README files, letting you focus on what matters: your code.

Stop staring at blank markdown files. Start shipping documentation that developers actually want to read.

Tech Stack

Frontend

React TypeScript Vite Tailwind CSS

UI & Libraries

Radix UI Framer Motion Monaco Editor dnd-kit

AI & APIs

Google Gemini GitHub API

Complete Documentation

⚙️ Setup Guide Local installation, development environment, and configuration
🏗️ Architecture Overview Project structure, design decisions, and technical architecture
🧩 Component Library Detailed catalog of all available README elements and examples
🤝 Contributing Guide How to contribute templates, components, and improvements
📜 Code of Conduct Community guidelines and expectations
🔒 Security Policy How to report vulnerabilities responsibly

🌟 Open Source Participation

Program Program Name Start Date End Date
SSoC Logo Social Summer of Code (SSoC) 25 June 2025 25 August 2025
SWoC Logo Social Winter of Code (SWoC) 1 Jan 2026 1 March 2026
Apertre3.0 Logo Apertre 3.0 1 Feb 2026 1 March 2026

Want to contribute? Read the Contributing Guidelines for detailed instructions.

About

Enhance your GitHub README with the README Design Kit.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors

Languages