unisharp/doc-us

A MySQL Schema Documantation Generator for Laravel

Maintainers

👁 storyn26383

Package info

github.com/UniSharp/doc-us

pkg:composer/unisharp/doc-us

Statistics

Installs: 24 537

Dependents: 0

Suggesters: 0

Stars: 38

Open Issues: 3

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

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT 8175acac629a92ff7245a3f8a4f53ee4b9a4a752

This package is auto-updated.

Last update: 2026-06-25 07:23:17 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

Supported Formats

  • html
  • markdown
  • json

exclude special table

Using comma to separate multiple table.

like

Demo

HTML

👁 html

Markdown

👁 markdown

Json

👁 json

Test

vendor/bin/phpunit tests

License

The DocUs released under MIT license.