UniSharp / doc-us by storyn26383

A MySQL Schema Documantation Generator for Laravel
13,917
37
13
Github Link
Packagist Link
Package Data
Maintainer Username: storyn26383
Maintainer Contact: unisharp-service@unisharp.com (UniSharp Ltd.)
Package Create Date: 2017-01-25
Package Last Update: 2019-01-30
Home Page:
Language: PHP
License: MIT
Last Refreshed: 2024-11-14 15:11:32
Package Statistics
Total Downloads: 13,917
Monthly Downloads: 209
Daily Downloads: 7
Total Stars: 37
Total Watchers: 13
Total Forks: 6
Total Open Issues: 3

Latest Stable Version Total Downloads License

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

html

Markdown

markdown

Json

json

Test

vendor/bin/phpunit tests

License

The DocUs released under MIT license.