JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q36300F
  • License MIT

Smart documentation generator for React/Next

Package Exports

  • smartdocs
  • smartdocs/config

Readme

SmartDocs 🧠✨

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

npm version License: MIT TypeScript

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

# Initialize project
npx smartdocs init

# Generate documentation
npx smartdocs build

# Start development server
npx smartdocs dev

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

📋 Commands

Command Description
npx smartdocs init Initialize with intelligent config
npx smartdocs build Generate static documentation
npx smartdocs dev Start development server
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

npx smartdocs build
npx vercel --prod smartdocs
# or upload smartdocs/ to any static host

🛠️ Requirements

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

Transform your React documentation with intelligence and beauty