{"id":15528594,"url":"https://github.com/mileschou/schemarkdown","last_synced_at":"2025-09-02T02:35:40.156Z","repository":{"id":62528968,"uuid":"273647452","full_name":"MilesChou/schemarkdown","owner":"MilesChou","description":"The core library for generate Markdown document from database schema.","archived":false,"fork":false,"pushed_at":"2024-08-03T02:51:31.000Z","size":1549,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-28T19:03:22.804Z","etag":null,"topics":["database","markdown","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/MilesChou.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-20T05:52:49.000Z","updated_at":"2024-08-03T02:50:03.000Z","dependencies_parsed_at":"2024-08-03T03:47:22.015Z","dependency_job_id":"860b3018-0492-4593-abf8-0f24403ded44","html_url":"https://github.com/MilesChou/schemarkdown","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":"MilesChou/composer-template","purl":"pkg:github/MilesChou/schemarkdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MilesChou%2Fschemarkdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MilesChou%2Fschemarkdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MilesChou%2Fschemarkdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MilesChou%2Fschemarkdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MilesChou","download_url":"https://codeload.github.com/MilesChou/schemarkdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MilesChou%2Fschemarkdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273220788,"owners_count":25066456,"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","status":"online","status_checked_at":"2025-09-02T02:00:09.530Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","markdown","schema"],"created_at":"2024-10-02T11:14:26.108Z","updated_at":"2025-09-02T02:35:40.117Z","avatar_url":"https://github.com/MilesChou.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Schemarkdown\n\n[![tests](https://github.com/MilesChou/schemarkdown/actions/workflows/tests.yml/badge.svg)](https://github.com/MilesChou/schemarkdown/actions/workflows/tests.yml)\n[![codecov](https://codecov.io/gh/MilesChou/schemarkdown/branch/master/graph/badge.svg)](https://codecov.io/gh/MilesChou/schemarkdown)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/67591518c2cd4c12bb73004998d08e29)](https://www.codacy.com/manual/MilesChou/schemarkdown)\n[![Latest Stable Version](https://poser.pugx.org/MilesChou/schemarkdown/v/stable)](https://packagist.org/packages/MilesChou/schemarkdown)\n[![Total Downloads](https://poser.pugx.org/MilesChou/schemarkdown/d/total.svg)](https://packagist.org/packages/MilesChou/schemarkdown)\n[![License](https://poser.pugx.org/MilesChou/schemarkdown/license)](https://packagist.org/packages/MilesChou/schemarkdown)\n\nThe core library for generate Markdown document and Laravel Eloquent Model classes from database schema.\n\n![](docs/example.gif)\n\n## Installation\n\nUse Composer to install:\n\n```bash\ncomposer require mileschou/schemarkdown\n```\n\n## Usage\n\nUse following command to generate schema documents:\n\n```bash\ncd /path/to/your-laravel-project\nphp artisan schema:markdown\n```\n\nSchema document are stored to `docs/schema` directory default. Use the `--path` option to change it.\n\nIn the other framework, you must provide config file like Laravel. Use `--config` option to specify customize configuration.\n\nThis tool will load `.env` before load config. Use the `--env` option to specify .env path.\n\nUse the `--database` option to specify **connection name** in Laravel config to generate the document of one database.\n\nUse the `--overwrite` option if you want to overwrite the exists document.\n\n---\n\nUse following command to generate eloquent models:\n\n```bash\ncd /path/to/your-laravel-project\nphp artisan schema:model\n```\n\nIt's will generate model code into `app/Models` directory (Laravel 8 default), use the `--path` option can change output dir. If want to change namespace, use the `--namespace` option.\n\nIn the other framework but using Eloquent ORM library, you must provide config file like laravel project. Use `--config` option to specify customize configuration.\n\nIf only want build one connection, use the `--database` option to specify.\n\nUse the `--overwrite` option if you want to overwrite exist code.\n\n## Example\n\nHere is example [SQL](/examples/examples.sql), import MySQL and run following command:\n\n```\nphp artisan schemarkdown --config=tests/Fixtures/database.php --database=examples --output-dir=examples\n```\n\nIt will generate this [Markdown documents](/examples).\n\n## Troubleshooting\n\nUse `-vv` option to see info log.\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmileschou%2Fschemarkdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmileschou%2Fschemarkdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmileschou%2Fschemarkdown/lists"}