https://github.com/unisharp/doc-us

A MySQL Schema Documentation Generator for Laravel.
https://github.com/unisharp/doc-us

database laravel php schema

Last synced: 11 months ago
JSON representation

A MySQL Schema Documentation Generator for Laravel.

• Host: GitHub
• URL: https://github.com/unisharp/doc-us
• Owner: UniSharp
• License: mit
• Created: 2017-01-25T04:08:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-01-30T13:12:49.000Z (over 7 years ago)
• Last Synced: 2025-07-12T09:39:43.522Z (12 months ago)
• Topics: database, laravel, php, schema
• Language: PHP
• Homepage:
• Size: 26.4 KB
• Stars: 38
• Watchers: 13
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![Latest Stable Version](https://poser.pugx.org/unisharp/doc-us/v/stable)](https://packagist.org/packages/unisharp/doc-us)

[![Total Downloads](https://poser.pugx.org/unisharp/doc-us/downloads)](https://packagist.org/packages/unisharp/doc-us)

[![License](https://poser.pugx.org/unisharp/doc-us/license)](https://packagist.org/packages/unisharp/doc-us)

# Doc Us

A MySQL Schema Documentation Generator for Laravel.

## Installation

1. Require this package with composer:

```bash

composer require unisharp/doc-us

```

2. Add `ENABLE_DOC_US` in `.env` (Default is disable)

```

ENABLE_DOC_US=true

```

3. 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.

```php

'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](http://i.imgur.com/EQaDRXMg.png)

#### Markdown

![markdown](http://i.imgur.com/kt92Uflg.png)

#### Json

![json](http://i.imgur.com/VCzAw3Qg.png)

## Test

```

vendor/bin/phpunit tests

```

## License

The DocUs released under [MIT license](https://unisharp.mit-license.org/).