umii/umii-autodoc

Auto documentation generator for Laravel apps (routes, models, configs, ERD, PDF export).

v1.1.8 2025-09-11 11:11 UTC

Requires

• php: >=8.2
• dompdf/dompdf: ^2.0 || ^3.0
• graphp/graphviz: ^0.2
• illuminate/support: ^10.0|^11.0|^12.0

MIT

• Umii (umii020)
• Umer Shahzad

README

Auto documentation generator for Laravel applications.

Features:

• Routes table (methods, URIs, controllers)
• API examples (GET/POST simple samples)
• Model list with fillable & basic relationship detection
• Middleware & policies overview (best-effort)
• Config overview (cache, queue, mail)
• ERD DOT export (docs/erd.dot)
• Screenshots: optional stub (requires a headless browser tool; the package will detect availability)

Install (local development)

1. Place this package folder into your Laravel project's packages/umii/umii-autodoc directory or require via composer.
2. Add "Umii\\AutoDoc\\UmiiAutoDocServiceProvider" to config/app.php providers (if not using package discovery).
3. Run:

   php artisan vendor:publish --provider="Umii\AutoDoc\UmiiAutoDocServiceProvider" --tag=config
   php artisan autodoc:generate
   

4. Output will be generated in docs/index.html (and docs/erd.dot).

Notes

• This is a starter implementation intended to be run inside a Laravel app. It uses Laravel's route and config systems.
• ERD generation produces a DOT file. Convert to SVG with Graphviz: dot -Tsvg docs/erd.dot -o docs/erd.svg
• Screenshots require an external tool (e.g., Browsershot / Puppeteer / Playwright). The package checks if Spatie\Browsershot\Browsershot exists.

Author

Umii — [e-mail] University: SZABIST Islamabad BSCS