@hexel-studio/codex-docs

Codex-Docs

🧠 AI-powered documentation generator for your codebase

Codex-Docs automatically generates comprehensive documentation from your code using AI, saving you time and ensuring docs stay in sync with your project.

✨ Features

• ⚡ Zero-config setup - Instant documentation with minimal setup
• 🧠 Smart code analysis - Auto-extracts APIs, types, and examples
• 📝 Markdown generation - Clean, structured documentation files
• 🔄 CI/CD integration - Keep docs updated with each commit
• 🎨 Customizable templates - Adapt to your project branding

📦 Installation

npm install @hexel-studio/codex-docs

🚀 Quick Start

# Generate docs in current project
npx codex-docs generate

# Specify output directory
npx codex-docs generate --output ./docs

# Generate only README
npx codex-docs readme

# Watch mode
npx codex-docs watch

⚙️ Configuration

Create a codex-docs.json in your project root:

{
  "project": {
    "name": "Your Project",
    "description": "Project description"
  },
  "output": "./docs",
  "formats": ["markdown", "html"],
  "exclude": ["node_modules/**", "dist/**"]
}

📚 Documentation

For complete documentation, visit our docs site.

📄 License

MIT © Hexel Studio