unisharp/doc-us

A MySQL Schema Documantation Generator for Laravel

Maintainers

Details

github.com/UniSharp/doc-us

Source

Issues

Installs: 14 180

Dependents: 0

Suggesters: 0

Security: 0

Stars: 37

Watchers: 13

Forks: 6

Open Issues: 3

v1.3.0 2018-02-22 10:01 UTC

Requires

Requires (Dev)

MIT 8175acac629a92ff7245a3f8a4f53ee4b9a4a752

This package is auto-updated.

Last update: 2024-11-25 04:11:09 UTC

README

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.