unisharp/doc-us

A MySQL Schema Documantation Generator for Laravel
27,035 38
Install
composer require unisharp/doc-us
Latest Version:v1.3.0
License:MIT
Last Updated:Jan 30, 2019
Links: GitHub  ·  Packagist
Maintainer: storyn26383

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.

Related Packages

doctrine/dbal

Powerful PHP database abstraction layer (DBAL) with many features for database s...

637,827,751 9,703
abstraction database db2 dbal mariadb mssql mysql oci8 oracle pdo pgsql postgresql queryobject sasql sql sqlite sqlserver sqlsrv
laravel/framework

The Laravel Framework.

589,172,971 34,950
framework laravel
laravel/tinker

Powerful REPL for the Laravel framework.

498,216,183 7,442
laravel psysh repl tinker
laravel/serializable-closure

Laravel Serializable Closure provides an easy and secure way to serialize closur...

413,412,504 609
closure laravel serializable
nunomaduro/collision

Cli error handling for console/command-line PHP applications.

394,964,158 4,660
artisan cli command-line console dev error handling laravel laravel-zero php symfony

Version History

Version Released Laravel License
v1.3.0 >5.3 MIT
v1.2.0 >5.3 MIT
v1.1.1 >5.3 MIT
v1.1.0 >5.3 MIT
v1.0.0 ^5.3 MIT