PHPackages                             unisharp/doc-us - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. unisharp/doc-us

ActiveLibrary[Database & ORM](/categories/database)

unisharp/doc-us
===============

A MySQL Schema Documantation Generator for Laravel

v1.3.0(8y ago)3822.3k↓11.8%6[3 issues](https://github.com/UniSharp/doc-us/issues)MITPHP

Since Jan 25Pushed 7y ago12 watchersCompare

[ Source](https://github.com/UniSharp/doc-us)[ Packagist](https://packagist.org/packages/unisharp/doc-us)[ RSS](/packages/unisharp-doc-us/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (5)Versions (8)Used By (0)

[![Latest Stable Version](https://camo.githubusercontent.com/371a30f5116d4e1b0468abf1d2c1d738a7405a97cf469e5564fe4ddf875a398d/68747470733a2f2f706f7365722e707567782e6f72672f756e6973686172702f646f632d75732f762f737461626c65)](https://packagist.org/packages/unisharp/doc-us)[![Total Downloads](https://camo.githubusercontent.com/7f2d75b8727fbc0d82225d4863ce29a4c2a760c324a2e38697aa78e5ae97cab0/68747470733a2f2f706f7365722e707567782e6f72672f756e6973686172702f646f632d75732f646f776e6c6f616473)](https://packagist.org/packages/unisharp/doc-us)[![License](https://camo.githubusercontent.com/d6ccd4aabdccbc9ed0b45810d6347d7fddb1bb498567655b47d7de0c29c0a1b8/68747470733a2f2f706f7365722e707567782e6f72672f756e6973686172702f646f632d75732f6c6963656e7365)](https://packagist.org/packages/unisharp/doc-us)

Doc Us
======

[](#doc-us)

A MySQL Schema Documentation Generator for Laravel.

Installation
------------

[](#installation)

1. Require this package with composer:

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

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

    UniSharp\DocUs\DocUsServiceProvider::class,

    /* ... */
];
```

Usage
-----

[](#usage)

### Output format

[](#output-format)

[http://{host}/schema?format={supported-format}](http://%7Bhost%7D/schema?format=%7Bsupported-format%7D)

Supported Formats

- html
- markdown
- json

### exclude special table

[](#exclude-special-table)

[http://{host}/schema?exclude={special-table}](http://%7Bhost%7D/schema?exclude=%7Bspecial-table%7D)

Using comma to separate multiple table.

like

[http://{host}/schema?exclude={table1},{table2}](http://%7Bhost%7D/schema?exclude=%7Btable1%7D,%7Btable2%7D)

Demo
----

[](#demo)

#### HTML

[](#html)

[![html](https://camo.githubusercontent.com/a3d022562d09c8b547411064c1b71eec78858e78481721705d8dde87f7b82b30/687474703a2f2f692e696d6775722e636f6d2f4551614452584d672e706e67)](https://camo.githubusercontent.com/a3d022562d09c8b547411064c1b71eec78858e78481721705d8dde87f7b82b30/687474703a2f2f692e696d6775722e636f6d2f4551614452584d672e706e67)

#### Markdown

[](#markdown)

[![markdown](https://camo.githubusercontent.com/4ced69666d5e73c83cbdfb33abbf245b6bc1fec2914f94ba1d107eaba076b594/687474703a2f2f692e696d6775722e636f6d2f6b74393255666c672e706e67)](https://camo.githubusercontent.com/4ced69666d5e73c83cbdfb33abbf245b6bc1fec2914f94ba1d107eaba076b594/687474703a2f2f692e696d6775722e636f6d2f6b74393255666c672e706e67)

#### Json

[](#json)

[![json](https://camo.githubusercontent.com/811282648b42142468851602725fb5ad3afba09007ed72af0f1e8d817ed92c31/687474703a2f2f692e696d6775722e636f6d2f56437a41773351672e706e67)](https://camo.githubusercontent.com/811282648b42142468851602725fb5ad3afba09007ed72af0f1e8d817ed92c31/687474703a2f2f692e696d6775722e636f6d2f56437a41773351672e706e67)

Test
----

[](#test)

```
vendor/bin/phpunit tests

```

License
-------

[](#license)

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

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity39

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 76.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~65 days

Recently: every ~96 days

Total

7

Last Release

3007d ago

Major Versions

v0.2.0 → v1.0.02017-02-03

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6954098?v=4)[Sasaya](/maintainers/storyn26383)[@storyn26383](https://github.com/storyn26383)

---

Top Contributors

[![storyn26383](https://avatars.githubusercontent.com/u/6954098?v=4)](https://github.com/storyn26383 "storyn26383 (13 commits)")[![bingluen](https://avatars.githubusercontent.com/u/6832868?v=4)](https://github.com/bingluen "bingluen (1 commits)")[![CatheCat](https://avatars.githubusercontent.com/u/14325344?v=4)](https://github.com/CatheCat "CatheCat (1 commits)")[![FWidm](https://avatars.githubusercontent.com/u/3480240?v=4)](https://github.com/FWidm "FWidm (1 commits)")[![streamtw](https://avatars.githubusercontent.com/u/7333171?v=4)](https://github.com/streamtw "streamtw (1 commits)")

---

Tags

databaselaravelphpschema

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/unisharp-doc-us/health.svg)

```
[![Health](https://phpackages.com/badges/unisharp-doc-us/health.svg)](https://phpackages.com/packages/unisharp-doc-us)
```

###  Alternatives

[cybercog/laravel-love

Make Laravel Eloquent models reactable with any type of emotions in a minutes!

1.2k302.7k1](/packages/cybercog-laravel-love)[cviebrock/eloquent-taggable

Easy ability to tag your Eloquent models in Laravel.

567694.8k3](/packages/cviebrock-eloquent-taggable)[clickbar/laravel-magellan

This package provides functionality for working with the postgis extension in Laravel.

423715.4k1](/packages/clickbar-laravel-magellan)[genealabs/laravel-pivot-events

This package introduces new eloquent events for sync(), attach(), detach() or updateExistingPivot() methods on BelongsToMany relation.

1404.9M8](/packages/genealabs-laravel-pivot-events)[reedware/laravel-relation-joins

Adds the ability to join on a relationship by name.

2121.2M13](/packages/reedware-laravel-relation-joins)[aglipanci/laravel-eloquent-case

Adds CASE statement support to Laravel Query Builder.

115157.2k](/packages/aglipanci-laravel-eloquent-case)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)