SmartDocs 🧠✨

Auto-generate beautiful, intelligent documentation for React/Next.js projects with zero configuration

SmartDocs intelligently analyzes your React codebase to create beautiful, modern documentation sites with zero configuration. It automatically categorizes components, hooks, pages, and services while generating component dependency visualizations.

✨ Key Features

• 🧠 Smart Categorization: Automatically detects components, hooks, pages, and services
• 🎨 Beautiful UI: Modern design with gradient backgrounds and animations
• ⚡ Zero Config: Works out of the box with intelligent defaults
• 📊 Dependency Mapping: Visual component relationship cards
• 🔍 Enhanced Search: Fuzzy matching across your codebase
• 🚀 Hot Reload: Instant updates during development

🚀 Quick Start

# Install globally (recommended)
npm install -g smartdocs

# Initialize project
smartdocs init        # or: npx smartdocs init

# Generate documentation  
smartdocs build       # or: npx smartdocs build

# Start development server
smartdocs dev          # or: npx smartdocs dev

SmartDocs automatically scans your codebase and generates a complete documentation site in smartdocs/ directory.

📋 Commands

| Command | Description | |---------|-------------| | smartdocs init or npx smartdocs init | Initialize with intelligent config | | smartdocs build or npx smartdocs build | Generate static documentation | | smartdocs dev or npx smartdocs dev | Start development server | | smartdocs check or npx smartdocs check | Validate configuration |

⚙️ Configuration

// smartdocs.config.ts
import { defineConfig } from "smartdocs/config";

export default defineConfig({
  projectName: "My App",
  entryPaths: ["**/*.{ts,tsx,js,jsx}"],
  exclude: ["node_modules/**", "dist/**"],
  outDir: "smartdocs"
});

🌍 Framework Support

• ✅ React Router, Next.js (App/Pages Router)
• ✅ Vite, Create React App
• ✅ TypeScript, Monorepos

🚀 Deploy

# Build documentation
smartdocs build       # or: npx smartdocs build

# Deploy to Vercel
npx vercel --prod smartdocs-dist

# Or upload smartdocs-dist/ to any static host

🛠️ Requirements

• Node.js 18+
• React 16.8+
• npm/yarn/pnpm

📚 Links

• GitHub
• Issues
• npm

Transform your React documentation with intelligence and beauty ✨