{"id":14069218,"url":"https://github.com/MatthewLaFalce/schema_to_md","last_synced_at":"2025-07-30T05:31:51.862Z","repository":{"id":131415572,"uuid":"198338447","full_name":"MatthewLaFalce/schema_to_md","owner":"MatthewLaFalce","description":":zap: Generate beautiful markdown documentation for your PostgreSQL Database from schema.rb files.","archived":false,"fork":false,"pushed_at":"2021-01-15T01:39:36.000Z","size":16,"stargazers_count":3,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-13T07:15:44.067Z","etag":null,"topics":["documentation","generator","markdown","postgresql","ruby","ruby-on-rails","schema"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/MatthewLaFalce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-07-23T02:42:43.000Z","updated_at":"2024-05-29T18:37:10.000Z","dependencies_parsed_at":"2023-05-11T08:30:33.138Z","dependency_job_id":null,"html_url":"https://github.com/MatthewLaFalce/schema_to_md","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatthewLaFalce%2Fschema_to_md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatthewLaFalce%2Fschema_to_md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatthewLaFalce%2Fschema_to_md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatthewLaFalce%2Fschema_to_md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MatthewLaFalce","download_url":"https://codeload.github.com/MatthewLaFalce/schema_to_md/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228092181,"owners_count":17868149,"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":["documentation","generator","markdown","postgresql","ruby","ruby-on-rails","schema"],"created_at":"2024-08-13T07:06:43.457Z","updated_at":"2024-12-04T10:31:07.585Z","avatar_url":"https://github.com/MatthewLaFalce.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eWelcome to Schema_to_md 👋\u003c/h1\u003e\n\u003cp\u003e\n  \u003cimg alt=\"Version\" src=\"https://img.shields.io/badge/version-v1.0-blue.svg?cacheSeconds=2592000\" /\u003e\n  \u003ca href=\"https://github.com/MatthewLaFalce/schema_to_md/blob/master/README.md\"\u003e\n    \u003cimg alt=\"Documentation\" src=\"https://img.shields.io/badge/documentation-yes-brightgreen.svg\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/MatthewLaFalce/schema_to_md/blob/master/LICENSE\"\u003e\n    \u003cimg alt=\"License: license\" src=\"https://img.shields.io/badge/License-license-yellow.svg\" target=\"_blank\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003e Generate beautiful markdown documentation for your PostgreSQL Database from schema.rb files.\n\n### 🏠 [Homepage](https://github.com/MatthewLaFalce/schema_to_md)\n\n## Install\n\n```bash\ngit clone git@github.com:MatthewLaFalce/schema_to_md.git\nexport PATH=$PATH:~/Github/schema_to_md\n# then follow Rails ERD installation below\n```\n\n## Usage\n\n```bash\n# Run this command at the head of any Rails Web App\nto_md\n```\n\n## Rails ERD\n\n```bash\n# Requires download of Graphviz\nbrew install graphviz       # Homebrew on Mac OS X\nsudo port install graphviz  # Macports on Mac OS X\nsudo apt install graphviz   # Debian and Ubuntu\n\n#put this in projects gem file\n\ngroup :development do\n  gem 'rails-erd'\nend\n\n# Then run\nbundle install\n\n# Generate simple erd\nrake erd filetype='png' notation=bachman filename='erd_simple'\n\n# Generate complex erd\nrake erd polymorphism=true filetype='png' notation=bachman filename='erd_complex'\n\n# Most Useful\nbundle exec rake erd polymorphism=true filetype='png' notation=bachman filename='erd' exclude='ApplicationRecord,Record,Searchable,PgSearch::Document,ActiveStorage::Attachment,ActiveStorage::Blob'\n```\n\n## Automated Rails ERD Setup\n\n```yml\n# Put this in your projects .erdconfig file\n#!/bin/yml\n\nfilename: 'erd'\nfiletype: 'png'\nnotation: 'bachman'\npolymorphism: true\ntitle: 'Docupiler ER Diagram'\nexclude: 'ApplicationRecord,Record,Searchable,PgSearch::Document,ActiveStorage::Attachment,ActiveStorage::Blob,ActiveRecord::InternalMetadata,ActiveRecord::SchemaMigration'\n```\n\n```ruby\n# Put this in your projects Gemfile\ngroup :development do\n  gem 'rails-erd'\nend\n\n# Put this in your project Rakefile if you uses :sql for your schema format\nRake::Task[\"db:migrate\"].enhance do\n  if ActiveRecord::Base.schema_format == :sql\n    Rake::Task[\"db:schema:dump\"].invoke\n  end\nend\n\n# Run this to install the Gem to your project\nbundle install\n\n# Run this to set up the Rake task to work with db:migrate\nbundle exec rails g erd:install\n\n# To generate your new diagram just run\nbundle exec rails db:migrate\n```\n\n## Author\n\n👤 **Matthew LaFalce**\n\n* Github: [@MatthewLaFalce](https://github.com/MatthewLaFalce)\n\n## Contributing\n\nContributions, issues and feature requests are welcome!\u003cbr /\u003eFeel free to check [issues page](https://github.com/MatthewLaFalce/schema_to_md/issues).\n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n## License\n\nCopyright © 2019 [Matthew LaFalce](https://github.com/MatthewLaFalce).\u003cbr /\u003e\nThis project is [MIT](https://github.com/MatthewLaFalce/schema_to_md/blob/master/LICENSE) licensed.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMatthewLaFalce%2Fschema_to_md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMatthewLaFalce%2Fschema_to_md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMatthewLaFalce%2Fschema_to_md/lists"}