https://github.com/leojkwan/claudux
AI-powered documentation generator for your codebase using Claude Code and VitePress
https://github.com/leojkwan/claudux
ai anthropic claude claude-code cleanup cli developer-tools doc-generator docs documentation link-check static-site vitepress
Last synced: 6 months ago
JSON representation
AI-powered documentation generator for your codebase using Claude Code and VitePress
- Host: GitHub
- URL: https://github.com/leojkwan/claudux
- Owner: leojkwan
- License: mit
- Created: 2025-08-04T17:45:49.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-08-26T14:17:59.000Z (6 months ago)
- Last Synced: 2025-08-26T17:10:37.235Z (6 months ago)
- Topics: ai, anthropic, claude, claude-code, cleanup, cli, developer-tools, doc-generator, docs, documentation, link-check, static-site, vitepress
- Language: Shell
- Homepage: https://www.npmjs.com/package/claudux
- Size: 503 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 🤖 Claudux — Your docs write themselves
> **Stop fighting stale documentation.** Claudux analyzes your codebase and generates comprehensive, navigable docs that actually stay in sync with your code.
[](https://www.npmjs.com/package/claudux)
[](https://opensource.org/licenses/MIT)
[](https://github.com/leojkwan/claudux)
> **⭐ If this saves you time, please star it!** Your support helps us build better tools for developers.
## 😤 The Problem Every Developer Knows
**Documentation debt is killing your productivity.** You ship features, but docs lag behind. New team members struggle to onboard. You spend weekends writing docs instead of building.
## ✨ The Solution
**Claudux** uses Claude AI to understand your codebase and generate production-ready documentation that:
- 🔄 **Stays current** - Updates with your code, not months later
- 🧠 **Actually understands** - Analyzes structure, patterns, and context
- ⚡ **Ships fast** - One command generates complete VitePress sites
- 🔒 **Runs locally** - Your code never leaves your machine
- 🍰 **Zero config** - Works out of the box, customize if needed
> **Meta proof:** [Claudux's own docs](https://leojkwan.github.io/claudux/) are generated by Claudux. We use our own tool daily.
## 🌟 Get started in 30 seconds
```bash
# Install globally
npm install -g claudux
# Generate docs for your project
cd your-project
claudux update
# Preview locally
claudux serve # → http://localhost:5173
```
## 🎬 See it in action
```bash
$ claudux update
📊 Analyzing codebase...
📋 Planning documentation structure...
✍️ Generating pages...
🔗 Validating links...
✅ Documentation ready! Run 'claudux serve' to preview
```
**The transformation:**
• Scattered README files → Organized documentation site
• Manual maintenance → Automated updates
• Broken links → Validated navigation
• Generic templates → Code-aware content
## 📚 Documentation
- **📖 [Live Documentation](https://leojkwan.github.io/claudux/)** - Browse online with full search & navigation
- Browse in-repo: [`docs/index.md`](docs/index.md)
- Preview locally: `claudux serve` - http://localhost:5173
## 🧠 How it works
Claudux uses a two‑phase flow to produce reliable docs:
1. **Plan**: analyze source code and produce a navigable outline + VitePress config
2. **Write**: generate pages with correct links, breadcrumbs, and cross‑references
## 🎨 Features
- **Code‑driven**: content comes from your actual project structure
- **Smart cleanup**: semantic obsolescence detection (not just regex)
- **VitePress‑ready**: clean config, search, edit links, and sensible defaults
- **Zero cloud lock‑in**: everything runs locally; keep your code private
## ✅ Requirements
- Node.js ≥ 18
- Claude CLI installed and authenticated (`claude config get`)
## 🛠️ Commands
```bash
claudux # Interactive menu
claudux update # Generate/update docs (includes cleanup & validation)
claudux update -m "..." # Update with focused directive for Claude
claudux serve # Start dev server (localhost:5173)
claudux recreate # Start fresh (delete all docs)
claudux create-template # Analyze codebase and generate CLAUDE.md
# Full usage
claudux --help
```
## 🔧 Configuration
Create a `docs-ai-config.json` in your project root:
```json
{
"projectName": "Your Awesome Project",
"primaryLanguage": "typescript",
"frameworks": ["react", "nextjs"],
"features": {
"apiDocs": true,
"tutorials": true,
"examples": true
}
}
```
## 🖼️ Screenshot & social
- README hero image: place `assets/readme-hero.png` (1600×900 recommended; `.webp` preferred)
- Optional social card for docs: place `docs/public/og-image.png` and add OG meta in VitePress config
## 🚀 GitHub Pages Deployment
Claudux includes a pre-configured GitHub Actions workflow (`.github/workflows/docs.yml`) that automatically:
- Builds your VitePress documentation on every push to `main`
- Deploys to GitHub Pages
- Sets up the correct base path and permissions
Just enable GitHub Pages in your repo settings → Pages → Source: "GitHub Actions"
## 🤝 Contributing
We welcome contributions. See [CONTRIBUTING.md](CONTRIBUTING.md).
## 📄 License
MIT — see [LICENSE](LICENSE) for details.
---
Keep your docs as fresh as your code.
📖 Live Documentation •
📦 Install from npm •
⭐ Star on GitHub •
🐛 Report issues