{"id":19706713,"url":"https://github.com/unisharp/doc-us","last_synced_at":"2025-07-19T06:04:43.289Z","repository":{"id":57075585,"uuid":"79981849","full_name":"UniSharp/doc-us","owner":"UniSharp","description":"A MySQL Schema Documentation Generator for Laravel.","archived":false,"fork":false,"pushed_at":"2019-01-30T13:12:49.000Z","size":27,"stargazers_count":38,"open_issues_count":3,"forks_count":6,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-07-12T09:39:43.522Z","etag":null,"topics":["database","laravel","php","schema"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UniSharp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-25T04:08:27.000Z","updated_at":"2024-11-29T20:12:14.000Z","dependencies_parsed_at":"2022-08-24T14:55:44.484Z","dependency_job_id":null,"html_url":"https://github.com/UniSharp/doc-us","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/UniSharp/doc-us","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UniSharp%2Fdoc-us","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UniSharp%2Fdoc-us/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UniSharp%2Fdoc-us/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UniSharp%2Fdoc-us/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UniSharp","download_url":"https://codeload.github.com/UniSharp/doc-us/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UniSharp%2Fdoc-us/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265895961,"owners_count":23845413,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","laravel","php","schema"],"created_at":"2024-11-11T21:36:40.586Z","updated_at":"2025-07-19T06:04:43.229Z","avatar_url":"https://github.com/UniSharp.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Latest Stable Version](https://poser.pugx.org/unisharp/doc-us/v/stable)](https://packagist.org/packages/unisharp/doc-us)\n[![Total Downloads](https://poser.pugx.org/unisharp/doc-us/downloads)](https://packagist.org/packages/unisharp/doc-us)\n[![License](https://poser.pugx.org/unisharp/doc-us/license)](https://packagist.org/packages/unisharp/doc-us)\n\n# Doc Us\n\nA MySQL Schema Documentation Generator for Laravel.\n\n## Installation\n\n1. Require this package with composer:\n\n```bash\ncomposer require unisharp/doc-us\n```\n\n2. Add `ENABLE_DOC_US` in `.env` (Default is disable)\n\n```\nENABLE_DOC_US=true\n```\n\n3. Add the ServiceProvider to the providers array in `config/app.php`:\n\n\u003e If you are using Laravel 5.5 or newer, you don’t need to do this step.\n\n```php\n'providers' =\u003e [\n    /* ... */\n\n    UniSharp\\DocUs\\DocUsServiceProvider::class,\n\n    /* ... */\n];\n```\n\n## Usage\n\n### Output format\n\n\u003chttp://{host}/schema?format={supported-format}\u003e\n\nSupported Formats\n\n- html\n- markdown\n- json\n\n### exclude special table\n\n\u003chttp://{host}/schema?exclude={special-table}\u003e\n\nUsing comma to separate multiple table.\n\nlike\n\n\u003chttp://{host}/schema?exclude={table1},{table2}\u003e\n\n## Demo\n\n#### HTML\n\n![html](http://i.imgur.com/EQaDRXMg.png)\n\n#### Markdown\n\n![markdown](http://i.imgur.com/kt92Uflg.png)\n\n#### Json\n\n![json](http://i.imgur.com/VCzAw3Qg.png)\n\n## Test\n\n```\nvendor/bin/phpunit tests\n```\n\n## License\n\nThe DocUs released under [MIT license](https://unisharp.mit-license.org/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funisharp%2Fdoc-us","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funisharp%2Fdoc-us","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funisharp%2Fdoc-us/lists"}