Skip to content

UniSharp/doc-us

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Latest Stable Version Total Downloads License

Doc Us

A MySQL Schema Documantation Generator for Laravel.

Installation

  1. Require this package with composer:
composer require unisharp/doc-us
  1. After updating composer, add the ServiceProvider to the providers array in config/app.php:
'providers' => [
    /* ... */

    UniSharp\DocUs\DocUsServiceProvider::class,

    /* ... */
];

Usage

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

Supported Formats

  • html
  • markdown
  • json (option)

Option (json format only)

  • true
  • false

Demo

html markdown json

Test

./vendor/bin/phpunit tests

License

The DocUs released under MIT license.

About

A MySQL Schema Documentation Generator for Laravel.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5