LumaDoc CLI

AI-powered documentation generator that creates modern React-based documentation sites from your codebase.

Installation

npm install -g lumadoc

Quick Start

# Initialize in your project
lumadoc init

# Generate React documentation site
lumadoc generate

# Build and serve
cd docs
npm install
npm run build
cd ..
lumadoc serve

What LumaDoc Creates

LumaDoc generates a complete React-based documentation website that includes:

• 🎨 Modern, responsive UI with Tailwind CSS
• 🔍 AI-analyzed code documentation
• 📱 Mobile-friendly design
• 🚀 Static build for easy hosting
• 🎯 Component-based architecture
• 📊 Project overview and API reference

Features

• 🤖 AI code analysis and documentation generation
• 📦 Complete React project output
• 🔒 Runs locally - no external API calls needed
• 📱 Responsive, modern UI
• 🚀 Production-ready static builds
• 📚 Multiple input formats (JSDoc, TypeScript, Python, etc.)
• 🎨 Customizable themes and branding

Generated Output

When you run lumadoc generate, you get:

docs/
├── package.json          # React project dependencies
├── vite.config.ts        # Build configuration
├── tailwind.config.js    # Styling configuration
├── src/
│   ├── main.tsx         # React app entry point
│   ├── App.tsx          # Main app component
│   ├── pages/           # Documentation pages
│   ├── components/      # UI components
│   ├── data/           # Generated docs data
│   └── index.css       # Styles
└── dist/               # Built static site (after npm run build)

Configuration

Edit lumadoc.yml to customize:

name: "My Project Documentation"
sources:
  - path: "./src/**/*.{js,ts,jsx,tsx}"
    type: "jsdoc"

ai:
  local:
    enabled: true
    models:
      - name: "gemma2-2b"
        id: "Xenova/gemma-2-2b"

output:
  destination: "./docs"
  formats:
    - type: "react"
      theme: "modern"

Commands

lumadoc init

Initialize configuration in your project

lumadoc generate

Generate a complete React documentation site:

• Analyzes your codebase with AI
• Creates a modern React app
• Generates documentation content
• Sets up build configuration

lumadoc serve

Serve the documentation locally:

• Automatically detects built vs. development mode
• Serves static files for production builds
• Provides development info for unbuilt projects

lumadoc watch

Watch for changes and regenerate docs (coming soon)

Building for Production

After running lumadoc generate:

cd docs
npm install        # Install React dependencies
npm run build     # Build static site
lumadoc serve     # Serve the built site

The built site in docs/dist/ can be deployed to any static hosting service:

• Netlify
• Vercel
• GitHub Pages
• AWS S3
• Any web server

Hosting

The generated site is a standard React application that builds to static files. You can:

1. Deploy the built files: Upload docs/dist/ to any web server
2. Use hosting services: Deploy directly to Netlify, Vercel, etc.
3. GitHub Pages: Commit the built files and enable GitHub Pages
4. CDN: Upload to AWS CloudFront, Azure CDN, etc.

Example Output

Your generated documentation site will have:

• Homepage: Project overview with modern design
• Documentation: Interactive sidebar navigation
• API Reference: AI-generated from your code
• Component Docs: Analysis of React components
• Search: Easy navigation through your docs
• Responsive Design: Works on all devices

License

MIT