churakovmike/laravel-db-doc-generator

Database documentation generator for laravel

0.1 2020-05-16 15:46 UTC

Requires

• ext-tokenizer: *
• doctrine/dbal: 2.9.x-dev
• illuminate/console: ^5.5|^6|^7
• illuminate/contracts: ^5.5|^6|^7
• illuminate/database: ^5.5|^6|^7
• illuminate/http: ^5.5|^6|^7
• illuminate/pagination: ^5.5|^6|^7
• illuminate/support: ^5.5|^6|^7
• illuminate/view: ^5.5|^6|^7

MIT

• Churakov Mike

• laravel
• database documentation
• laravel documentation

README

Requirements

• laravel 5.5+
• Tokenizer Extension

Getting started

Installation

The package is available on packagist.

composer require churakovmike/laravel-db-doc-generator

or

php composer.phar require churakovmike/laravel-db-doc-generator

Register service provider in config/app.php

ChurakovMike\DbDocumentor\DbDocumentorServiceProvider::class,       

Usage

Run in from command-line with next command

php artisan db-doc:generate

By default database documentation will be generate in ./public/db-doc/ If you need to change output destination, run command with --output argument

php artisan db-doc:generate --output=path/to/your/destination

When running DbDocumentor there are some command-line options

1. --output, specifies the directory to output generated documentation.
2. --model-path, specifies the directory for searching Eloquent model files.
3. --excluded-dir, specifies the directories to ignore during the search.
4. --lang, specifies the documentation language.