2017 © Pedro Peláez
 

library doc-us

A MySQL Schema Documantation Generator for Laravel

image

unisharp/doc-us

A MySQL Schema Documantation Generator for Laravel

  • Thursday, February 22, 2018
  • by storyn26383
  • Repository
  • 11 Watchers
  • 14 Stars
  • 493 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 8 Versions
  • 80 % Grown

The README.md

Latest Stable Version Total Downloads License, (*1)

Doc Us

A MySQL Schema Documentation Generator for Laravel., (*2)

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., (*3)

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

    UniSharp\DocUs\DocUsServiceProvider::class,

    /* ... */
];

Usage

Output format

http://{host}/schema?format={supported-format}, (*4)

Supported Formats, (*5)

  • html
  • markdown
  • json

exclude special table

http://{host}/schema?exclude={special-table}, (*6)

Using comma to separate multiple table., (*7)

like, (*8)

http://{host}/schema?exclude={table1},{table2}, (*9)

Demo

HTML

html, (*10)

Markdown

markdown, (*11)

Json

json, (*12)

Test

vendor/bin/phpunit tests

License

The DocUs released under MIT license., (*13)

The Versions

22/02 2018

dev-master

9999999-dev

A MySQL Schema Documantation Generator for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by UniSharp Ltd.

22/02 2018

v1.3.0

1.3.0.0

A MySQL Schema Documantation Generator for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by UniSharp Ltd.

22/02 2018

v1.2.0

1.2.0.0

A MySQL Schema Documantation Generator for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by UniSharp Ltd.

07/02 2017

v1.1.1

1.1.1.0

A MySQL Schema Documantation Generator for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by UniSharp Ltd.

03/02 2017

v1.1.0

1.1.0.0

A MySQL Schema Documantation Generator for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by UniSharp Ltd.

03/02 2017

v1.0.0

1.0.0.0

A MySQL Schema Documantation Generator for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by UniSharp Ltd.

28/01 2017

v0.2.0

0.2.0.0

A MySQL Schema Documantation Generator for Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by UniSharp Ltd.

25/01 2017

v0.1.0

0.1.0.0

  Sources   Download

The Requires

 

The Development Requires

by UniSharp Ltd.