{"id":14070522,"url":"https://github.com/IllusiveBagel/DBMLDocs","last_synced_at":"2025-07-30T07:33:45.385Z","repository":{"id":46054309,"uuid":"360591050","full_name":"IllusiveBagel/DBMLDocs","owner":"IllusiveBagel","description":"A Standalone Site for Displaying Database Documentation Based on DBML Files","archived":false,"fork":false,"pushed_at":"2022-10-03T19:23:17.000Z","size":977,"stargazers_count":9,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-06-17T22:48:34.324Z","etag":null,"topics":["dbml","documentation","reactjs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IllusiveBagel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2021-04-22T16:49:16.000Z","updated_at":"2023-03-07T10:24:29.000Z","dependencies_parsed_at":"2023-01-19T03:32:04.965Z","dependency_job_id":null,"html_url":"https://github.com/IllusiveBagel/DBMLDocs","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IllusiveBagel%2FDBMLDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IllusiveBagel%2FDBMLDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IllusiveBagel%2FDBMLDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IllusiveBagel%2FDBMLDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IllusiveBagel","download_url":"https://codeload.github.com/IllusiveBagel/DBMLDocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":215155197,"owners_count":15836926,"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":["dbml","documentation","reactjs"],"created_at":"2024-08-13T07:07:49.685Z","updated_at":"2024-08-13T07:17:14.154Z","avatar_url":"https://github.com/IllusiveBagel.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# DBML Docs\nA React based standalone site for generating documentation based on a DBML file. The purpose of this project is to allow the automatic generation of a documentation site for your database and allow you to host that site yourself keeping all of your data and documentation in house.\n\n[Live Demo (Coming Soon)]()\n\n### How to Use\n1. Clone Repo\n```\ngit clone https://github.com/IllusiveBagel/DBMLDocs.git\n```\n2. Install Dependencies\n```\nyarn install\n```\n3. Replace Example.dbml in the ```public/Database``` folder with your dbml file. \n4. change the DatabaseName field in ```src/config.json``` to the name of your dbml file.\n5. Start the Site\n```\nyarn start\n```\n\n### Supported Features\n| Feature               | Supported               | Notes                                |\n|:---------------------:|:-----------------------:|:------------------------------------:|\n| Project Definition    | :heavy_check_mark:      |                                      |\n| Table Definition      | :heavy_check_mark:      |                                      |\n| Table Alias           | :heavy_check_mark:      |                                      |\n| Table Notes           | :heavy_check_mark:      |                                      |\n| Table Settings        | :x:                     | Not Yet Supported By DBML Standard   |\n| Column Definition     | :heavy_check_mark:      |                                      |\n| Default Value         | :heavy_check_mark:      |                                      |\n| Index Definition      | :x:                     |                                      |\n| Index Settings        | :x:                     |                                      |\n| Relationships         | :ballot_box_with_check: | One to One Definitions Not Supported |\n| Relationship Settings | :x:                     |                                      |\n| Note Definition       | :heavy_check_mark:      | Full Mardown Support of Project Note |\n| Enum Definition       | :x:                     |                                      |\n| Table Groups          | :x:                     |                                      |\n\n[DBML Documentation](https://www.dbml.org/docs)\n\n### About Example.dbml\nThe Example file that deploys with the code includes all of the supported features and can be used to give a good display of how DBMLDocs works.\n\nCurrently included in the Example is 2 tables with a simple reference connecting the two tables. This file will be updated with the project to display all functionality.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIllusiveBagel%2FDBMLDocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FIllusiveBagel%2FDBMLDocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIllusiveBagel%2FDBMLDocs/lists"}