https://github.com/mileschou/schemarkdown

The core library for generate Markdown document from database schema.
https://github.com/mileschou/schemarkdown

database markdown schema

Last synced: 3 months ago
JSON representation

The core library for generate Markdown document from database schema.

• Host: GitHub
• URL: https://github.com/mileschou/schemarkdown
• Owner: MilesChou
• License: mit
• Created: 2020-06-20T05:52:49.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-03T02:51:31.000Z (12 months ago)
• Last Synced: 2025-03-29T23:41:19.561Z (4 months ago)
• Topics: database, markdown, schema
• Language: PHP
• Homepage:
• Size: 1.48 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Schemarkdown

[![tests](https://github.com/MilesChou/schemarkdown/actions/workflows/tests.yml/badge.svg)](https://github.com/MilesChou/schemarkdown/actions/workflows/tests.yml)

[![codecov](https://codecov.io/gh/MilesChou/schemarkdown/branch/master/graph/badge.svg)](https://codecov.io/gh/MilesChou/schemarkdown)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/67591518c2cd4c12bb73004998d08e29)](https://www.codacy.com/manual/MilesChou/schemarkdown)

[![Latest Stable Version](https://poser.pugx.org/MilesChou/schemarkdown/v/stable)](https://packagist.org/packages/MilesChou/schemarkdown)

[![Total Downloads](https://poser.pugx.org/MilesChou/schemarkdown/d/total.svg)](https://packagist.org/packages/MilesChou/schemarkdown)

[![License](https://poser.pugx.org/MilesChou/schemarkdown/license)](https://packagist.org/packages/MilesChou/schemarkdown)

The core library for generate Markdown document and Laravel Eloquent Model classes from database schema.

![](docs/example.gif)

## Installation

Use Composer to install:

```bash

composer require mileschou/schemarkdown

```

## Usage

Use following command to generate schema documents:

```bash

cd /path/to/your-laravel-project

php artisan schema:markdown

```

Schema document are stored to `docs/schema` directory default. Use the `--path` option to change it.

In the other framework, you must provide config file like Laravel. Use `--config` option to specify customize configuration.

This tool will load `.env` before load config. Use the `--env` option to specify .env path.

Use the `--database` option to specify **connection name** in Laravel config to generate the document of one database.

Use the `--overwrite` option if you want to overwrite the exists document.

---

Use following command to generate eloquent models:

```bash

cd /path/to/your-laravel-project

php artisan schema:model

```

It'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.

In the other framework but using Eloquent ORM library, you must provide config file like laravel project. Use `--config` option to specify customize configuration.

If only want build one connection, use the `--database` option to specify.

Use the `--overwrite` option if you want to overwrite exist code.

## Example

Here is example [SQL](/examples/examples.sql), import MySQL and run following command:

```

php artisan schemarkdown --config=tests/Fixtures/database.php --database=examples --output-dir=examples

```

It will generate this [Markdown documents](/examples).

## Troubleshooting

Use `-vv` option to see info log.

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.