zerodoc-gen 1.4.4
Zero-config documentation generator with beautiful UI
License: MIT
Requires Python: >=3.8
Keywords: documentation, generator, python, typer, cli

# ZeroDoc - Zero-Config Documentation Generator

**Generate beautiful documentation from your codebase with zero configuration.**

ZeroDoc scans your project, extracts API information, and creates a clean, searchable documentation website - all with a single command.

## 🚀 Features

- **Multi-Language Support**: Python, JavaScript, TypeScript, Go, Rust, Java, C/C++, and more
- **Zero Configuration**: Works out of the box with any project
- **AST-based Parsing**: Accurately extracts API information using language-specific parsers
- **Markdown Generation**: Creates clean, readable markdown documentation
- **Static Site Export**: Converts docs to a beautiful HTML site
- **Jinja2 Templates**: Customizable README and documentation templates
- **CLI Interface**: Simple commands powered by Typer
- **Fast & Lightweight**: Generates docs in seconds, not minutes

## 📦 Installation

```bash
# Install from PyPI
pip install zerodoc-gen

# Or use pipx for isolated installation
pipx install zerodoc-gen

# Install from source
git clone https://github.com/yourusername/zerodoc.git
cd zerodoc
pip install -e .
```

## 🎯 Quick Start

```bash
# One command to generate everything
autodoc generate .

# Or if installed via pip (not in PATH)
python3 -m autodoc.cli generate .

# With AI enhancement (requires API key)
autodoc generate . --ai

# Generate and serve locally
autodoc generate . --serve
```

## 📚 Commands

### `autodoc generate` (Recommended)
The all-in-one command that scans, builds, and exports documentation.

```bash
# Basic usage
autodoc generate .
python3 -m autodoc.cli generate .

# With options
autodoc generate . --output public/docs  # Custom output directory
autodoc generate . --ai                  # Enable AI enhancement
autodoc generate . --no-ai               # Explicitly disable AI
autodoc generate . --serve               # Start local server after generation
autodoc generate . --non-interactive     # No prompts (for CI/CD)

# Framework auto-detection
autodoc generate .  # Automatically detects Next.js, React, Vue, etc.
```

### Individual Commands

#### `autodoc scan`
Scans your codebase and extracts API information.

```bash
autodoc scan [PATH] --out build/api.json --verbose
python3 -m autodoc.cli scan .
```

#### `autodoc docs`
Generates markdown documentation from scanned data.

```bash
autodoc docs [PATH] --output docs --verbose
python3 -m autodoc.cli docs .
```

#### `autodoc export`
Converts markdown to a static HTML site.

```bash
autodoc export --source docs --dest site --serve
python3 -m autodoc.cli export --serve
```

## 💡 Why ZeroDoc?

- **Cost-Effective**: Free and open-source vs $65-79/month for GitBook
- **Developer-First**: Built by developers, for developers
- **No Lock-in**: Your docs stay in your repo as markdown
- **CI/CD Ready**: Integrate with GitHub Actions for automatic doc updates
- **Fast**: Generates docs for large codebases in seconds

## 🔥 Common Use Cases

### Next.js / React Projects
```bash
# Automatically detects and configures for Next.js
autodoc generate .
# Or with python3
python3 -m autodoc.cli generate .
```

### Python Package
```bash
# Generate API documentation with AI enhancement
export OPENAI_API_KEY=sk-...  # Or use Anthropic, Groq, Ollama
python3 -m autodoc.cli generate . --ai
```

### CI/CD Pipeline
```bash
# Non-interactive mode for GitHub Actions, etc.
python3 -m autodoc.cli generate . --non-interactive --no-ai
```

### Custom Output Directory
```bash
# For static site generators like Jekyll, Hugo
python3 -m autodoc.cli generate . --output static/api-docs
```

## 🛠️ Development

```bash
# Clone the repository
git clone https://github.com/yourusername/zerodoc.git
cd zerodoc

# Install in development mode
pip install -e ".[dev]"

# Run on itself to test
python3 -m autodoc.cli generate .
python3 -m autodoc.cli generate . --serve  # With local preview
```

## 🌍 Supported Languages

ZeroDoc supports documentation generation for:

- **Python**: Full AST-based parsing with docstrings, type hints, decorators
- **JavaScript/TypeScript**: Classes, functions, async/await, ES6+ features  
- **Go**: Packages, structs, interfaces, methods, goroutines
- **Rust**: Structs, enums, traits, impl blocks, lifetimes
- **Java**: Classes, interfaces, generics, annotations
- **C/C++**: Classes, structs, functions, templates
- **Ruby, PHP, Swift, Kotlin**: Basic support via tree-sitter
- **And more**: 40+ languages supported through tree-sitter

## 🤝 Contributing

We welcome contributions! Here are some good first issues:

1. **Improve language parsers**: Enhance extraction for specific languages
2. **Improve themes**: Add more CSS themes or Tailwind support
3. **Git integration**: Auto-commit docs on successful generation
4. **AI enrichment**: Use LLMs to enhance documentation

## 📊 Statistics

- Lines of Code: < 1000
- Dependencies: Minimal (typer, jinja2, markdown-it-py)
- Performance: Processes 1000+ files in < 5 seconds
- Memory: < 50MB for large codebases

## 🗺️ Roadmap

- [ ] Multi-language support (JavaScript, TypeScript, Go, Rust)
- [ ] Plugin system for custom processors
- [ ] Docusaurus/MkDocs export formats
- [ ] API change detection and PR comments
- [ ] Local AI integration for doc enhancement
- [ ] Search functionality in exported sites

## 📄 License

Proprietary - For author's use only. All rights reserved.

## 🙏 Acknowledgments

- Built with [Typer](https://typer.tiangolo.com/) - The amazing CLI framework
- Inspired by the need for affordable, quality documentation tools
- Thanks to all contributors and early adopters

---


*Stop paying for expensive doc platforms. Start using ZeroDoc.*