README

Doc Us

A MySQL Schema Documentation Generator for Laravel.

Installation

1. Require this package with composer:

composer require unisharp/doc-us

1. Add ENABLE_DOC_US in .env (Default is disable)

ENABLE_DOC_US=true

1. Add the ServiceProvider to the providers array in config/app.php:

If you are using Laravel 5.5 or newer, you don’t need to do this step.

'providers' => [
    /* ... */

    UniSharp\DocUs\DocUsServiceProvider::class,

    /* ... */
];

Usage

Output format

http://{host}/schema?format={supported-format}

Supported Formats

• html
• markdown
• json

exclude special table

http://{host}/schema?exclude={special-table}

Using comma to separate multiple table.

like

http://{host}/schema?exclude={table1},{table2}

Demo

HTML

Markdown

Json

Test

vendor/bin/phpunit tests

License

The DocUs released under MIT license.