libry-inc/laravel-docgen

A Laravel tool to auto-generate a document from data, like DB

v0.1.1 2024-10-10 05:54 UTC

Requires

• php: ^8.2.0
• illuminate/support: >=11.0.0

Requires (Dev)

• laravel/framework: >=11.0.0
• laravel/tinker: >=2.0.0

MIT

• Libry Inc.

• php
• laravel
• laravel-docgen

README

This is a library that helps you almost automatically generate documents with data gathered from like a DB schema. This library uses Laravel but your application doesn't necessarily need to. You can edit the output with Blade PHP, like below: ↓

Installation

composer require --dev libry-inc/laravel-docgen
artisan vendor:publish --tag=docgen

Usage

Publish and generate a sample document

artisan vendor:publish --tag=docgen.sample
artisan docgen db.sample

Customize

• To change I/O directions, modify config/docgen.php
• To change outputs, modify resources/docgen/...

Contributions

Install

docker buildx bake
docker compose up -d
docker compose exec php composer install

Pre-commit

docker compose exec php composer fixer