🚀 Quick Start • ✨ Features • 📖 Demo • 🎯 Use Cases • ⚙️ CLI Options • 🤝 Contributing

🎯 What is repo-docgen?

repo-docgen is an intelligent, zero-configuration CLI tool that automatically analyzes your entire codebase and generates beautiful, comprehensive, production-ready documentation in seconds. Say goodbye to manual README writing!

💡 Why Choose repo-docgen?

🎬 See It in Action

One Command, Complete Documentation

npx repo-docgen

That's literally it! Watch as repo-docgen:

• 🔍 Scans your entire project structure
• 🧠 Detects all frameworks and technologies
• 📊 Analyzes dependencies and architecture
• 🌐 Extracts API routes automatically
• ✨ Generates beautiful markdown documentation

📸 What You Get

Before 😔

my-project/
├── src/
├── package.json
└── (no documentation)

After 🎉

my-project/
├── src/
├── package.json
├── 📄 README.md ✨
├── 📄 STRUCTURE.md ✨
└── 📄 API.md ✨

✨ Features

• 🎯 Smart Tech Stack Detection - Automatically identifies all frameworks, libraries, and tools
• 🏗️ Architecture Recognition - Detects frontend-only, backend-only, full-stack, or monorepo structures
• 📦 Monorepo Support - Handles npm, yarn, and pnpm workspaces seamlessly
• 🔄 Recursive Scanning - Deep analysis of entire project structure
• 🌐 API Route Extraction - Automatically finds and documents all API endpoints
• 📊 Dependency Analysis - Merges and analyzes dependencies from all package.json files

• 📄 README.md - Comprehensive project overview with badges, tech stack, and setup guide
• 🗂️ STRUCTURE.md - Visual tree-based project structure with file statistics
• 🌐 API.md - Complete API documentation with HTTP method badges and examples
• 🎨 Modern Formatting - Emoji-enhanced, collapsible sections, and beautiful tables
• 🔗 Smart Links - Automatic navigation links and table of contents
• 📊 Visual Diagrams - Mermaid diagrams for architecture visualization

| Category | Technologies | |----------|-------------| | Frontend | React, Vue, Angular, Svelte, Next.js, Nuxt, Remix, Astro, Solid.js, Qwik, Preact | | Backend | Express, Fastify, Koa, NestJS, Hapi, Adonis, Strapi, Sails.js | | Databases | MongoDB, PostgreSQL, MySQL, Redis, Prisma, TypeORM, Sequelize, Mongoose | | Build Tools | Vite, Webpack, Rollup, Parcel, esbuild, Turbopack, SWC | | Testing | Jest, Vitest, Cypress, Playwright, Testing Library, Mocha, Chai | | Styling | Tailwind CSS, Styled Components, Emotion, Sass, Less, PostCSS | | State Management | Redux, Zustand, Jotai, Recoil, MobX, Pinia, Vuex | | Meta Frameworks | Next.js, Nuxt, SvelteKit, Remix, Astro, Gatsby, Redwood |

🚀 Quick Start

⚡ Instant Usage (Recommended)

No installation required! Run directly with npx:

npx repo-docgen

That's it! 🎉 Your documentation will be generated instantly.

📦 Global Installation

Install once, use everywhere:

npm install -g repo-docgen

Then run in any project:

docgen

🎯 Project-Specific Usage

Navigate to your project and run:

cd your-awesome-project
npx repo-docgen

📖 Examples

🎬 Basic Usage

# Generate docs in current directory (default)
npx repo-docgen

# Generate in custom output directory
npx repo-docgen --output=docs

# Overwrite existing documentation
npx repo-docgen --overwrite

# Combine options
npx repo-docgen --output=documentation --overwrite

📁 Generated Files

After running repo-docgen, you'll get:

your-project/
├── 📄 README.md          # 🎯 Main project documentation
│   ├── Project overview with badges
│   ├── Tech stack breakdown
│   ├── Installation guide
│   ├── Usage examples
│   ├── Available scripts
│   └── Contributing guidelines
│
├── 📄 STRUCTURE.md       # 🗂️ Project structure visualization
│   ├── Tree-based folder structure
│   ├── File statistics
│   ├── Folder descriptions
│   └── Root file explanations
│
└── 📄 API.md            # 🌐 API documentation (if backend detected)
    ├── Grouped endpoints
    ├── HTTP method badges
    ├── Request/response examples
    └── Testing instructions

🎨 Sample Output Preview

# 🚀 Your Project Name

> Modern, scalable web application built with React and Express

## 🛠️ Tech Stack

**Frontend:**
- ⚛️ React 18.2.0
- ⚡ Vite 4.3.0
- 🎨 Tailwind CSS 3.3.0

**Backend:**
- 🚀 Express 4.18.2
- 🗄️ MongoDB with Mongoose
- 🔐 JWT Authentication

## 🚀 Getting Started

### Prerequisites
- Node.js >= 18.0.0
- npm or yarn

### Installation
\`\`\`bash
npm install
\`\`\`

### Development
\`\`\`bash
npm run dev
\`\`\`

# 📁 Project Structure

## 📊 Statistics
- **Total Files:** 156
- **Total Folders:** 42
- **Total Size:** 2.3 MB

## 🌳 Directory Tree

\`\`\`
project-root/
├── 📂 src/
│   ├── 📂 components/
│   ├── 📂 pages/
│   ├── 📂 utils/
│   └── 📄 App.jsx
├── 📂 public/
├── 📄 package.json
└── 📄 README.md
\`\`\`

# 🌐 API Documentation

## 👤 User Routes

### ![GET](https://img.shields.io/badge/GET-4CAF50) `/api/users`
Get all users

### ![POST](https://img.shields.io/badge/POST-2196F3) `/api/users`
Create new user

🎯 Use Cases

🚀 New Projects

Bootstrap professional documentation instantly for your new project. Perfect for hackathons, MVPs, and side projects.

Example:

create-vite my-app
cd my-app
npx repo-docgen

📦 Monorepos

Handle complex multi-package structures with ease. Detects workspaces and generates unified documentation.

Example:

cd my-monorepo
npx repo-docgen
# Analyzes all packages automatically

🔄 Legacy Code

Document existing projects quickly without manual effort. Great for inherited codebases.

Example:

cd legacy-project
npx repo-docgen --overwrite
# Fresh docs in seconds

👥 Open Source

Create contributor-friendly documentation that encourages collaboration.

Example:

npx repo-docgen
# Professional docs ready for GitHub

⚙️ CLI Options

| Option | Alias | Description | Default | Example | |--------|-------|-------------|---------|---------| | --output=<dir> | -o | Output directory for generated docs | . (root) | --output=docs | | --overwrite | -f | Force overwrite existing documentation | false | --overwrite | | --help | -h | Show help information | - | --help | | --version | -v | Show version number | - | --version |

📝 Usage Examples

# Generate in 'documentation' folder
npx repo-docgen --output=documentation

# Force regenerate all docs
npx repo-docgen --overwrite

# Custom folder + overwrite
npx repo-docgen -o my-docs -f

# Show help
npx repo-docgen --help

🏗️ How It Works

graph TB
    A[🚀 Start] --> B[📂 Scan Project Files]
    B --> C[📦 Analyze package.json]
    C --> D[🔍 Detect Tech Stack]
    D --> E[🏗️ Classify Architecture]
    E --> F[🌐 Extract API Routes]
    F --> G[📊 Analyze Dependencies]
    G --> H[✨ Generate Documentation]
    H --> I[📄 README.md]
    H --> J[🗂️ STRUCTURE.md]
    H --> K[🌐 API.md]
    I --> L[✅ Done!]
    J --> L
    K --> L
    
    style A fill:#4CAF50,stroke:#333,stroke-width:2px,color:#fff
    style L fill:#2196F3,stroke:#333,stroke-width:2px,color:#fff
    style H fill:#FF9800,stroke:#333,stroke-width:2px,color:#fff

🔄 Process Breakdown

1. 📂 Recursive Scanning - Traverses entire project directory structure
2. 📦 Package Analysis - Reads all package.json files (root + sub-projects)
3. 🔍 Tech Detection - Identifies frameworks, libraries, and tools from dependencies
4. 🏗️ Architecture Classification - Determines if project is frontend, backend, full-stack, or monorepo
5. 🌐 API Extraction - Scans code for API routes and endpoints
6. 📊 Dependency Merging - Combines dependencies from all packages
7. ✨ Doc Generation - Creates beautiful, structured markdown documentation

📦 Supported Project Types

🎨 What Makes It Special?

🧠 Intelligent Analysis

Unlike basic doc generators, repo-docgen offers:

• ✅ Deep Recursive Scanning - Analyzes entire project tree, not just root
• ✅ Monorepo Intelligence - Detects and handles npm/yarn/pnpm workspaces
• ✅ Dual-Stack Detection - Identifies both frontend AND backend technologies
• ✅ Automatic API Discovery - Extracts routes from Express, Fastify, NestJS, etc.
• ✅ Context-Aware Descriptions - Generates meaningful, project-specific content
• ✅ Dependency Merging - Combines deps from all package.json files

🎯 Zero Configuration

No config files, no setup, no learning curve:

npx repo-docgen  # That's it! ✨

📊 Comprehensive Coverage

Supports 100+ frameworks and tools across:

• React, Vue, Angular, Svelte, Solid.js
• Next.js, Nuxt, SvelteKit, Remix, Astro
• Gatsby, Redwood, Qwik, Preact, Alpine.js
• Lit, Stencil, Ember, Backbone, Aurelia

• Express, Fastify, Koa, Hapi, Restify
• NestJS, AdonisJS, Strapi, Sails.js
• Meteor, FeathersJS, LoopBack, Total.js

• MongoDB, PostgreSQL, MySQL, SQLite, Redis
• Prisma, TypeORM, Sequelize, Mongoose, Knex
• Drizzle, MikroORM, Objection.js, Bookshelf

• Vite, Webpack, Rollup, Parcel, esbuild
• Turbopack, SWC, Snowpack, Browserify
• Gulp, Grunt, Brunch

• Jest, Vitest, Mocha, Jasmine, Karma
• Cypress, Playwright, Puppeteer, TestCafe
• Testing Library, Enzyme, Ava, Tape

• Tailwind CSS, Bootstrap, Material-UI
• Styled Components, Emotion, CSS Modules
• Sass, Less, PostCSS, Stylus, UnoCSS

📊 Real-World Performance

| Metric | Value | |--------|-------| | ⚡ Average Generation Time | < 5 seconds | | 📦 Package Size | Lightweight & Fast | | 🎯 Frameworks Detected | 100+ | | 🌐 API Routes Extracted | Unlimited | | 📁 Project Types Supported | 5+ |

🤝 Contributing

We love contributions! Here's how you can help make repo-docgen even better:

🐛 Report Bugs

Found a bug? Open an issue with:

• Clear description
• Steps to reproduce
• Expected vs actual behavior
• Screenshots (if applicable)

💡 Suggest Features

Have an idea? Share it with us by:

• Describing the feature
• Explaining the use case
• Providing examples

🔧 Submit Pull Requests

Ready to code? Follow these steps:

# 1. Fork the repository
# 2. Clone your fork
git clone https://github.com/its-rahul-r15/repo-docgen.git

# 3. Create a feature branch
git checkout -b feature/amazing-feature

# 4. Install dependencies
npm install

# 5. Make your changes
# 6. Test your changes
npm start

# 7. Commit your changes
git commit -m "Add amazing feature"

# 8. Push to your fork
git push origin feature/amazing-feature

# 9. Open a Pull Request

📖 Improve Documentation

Help others by:

• Fixing typos
• Adding examples
• Improving clarity
• Translating docs

📊 Project Stats

📄 License

This project is licensed under the ISC License - see the LICENSE file for details.

👨‍💻 Author

Rahul Sharma

🌟 Show Your Support

If repo-docgen helped you, please consider:

⭐ Star this repo on GitHub
📢 Share with your developer friends
🐛 Report issues you encounter
💡 Suggest features you'd like to see
🤝 Contribute to make it better

🔗 Related Projects

Explore other awesome documentation tools:

• readme-md-generator - Interactive README generator with CLI prompts
• auto-readme - Simple and lightweight README generator
• documentation.js - JSDoc-based API documentation generator
• readme-so - Online README editor with live preview
• shields.io - Badge generator for your README

🎉 Acknowledgments

Special thanks to:

• 🙏 All contributors who helped improve this project
• 💡 The open-source community for inspiration
• 🚀 Everyone who uses and supports repo-docgen

📞 Support

Need help? We're here for you:

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions
• 📧 Email Support

💖 Made with love by developers, for developers

⬆ Back to Top

👋