A 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.
- Clone Repo
git clone https://github.com/IllusiveBagel/DBMLDocs.git
- Install Dependencies
yarn install
- Replace Example.dbml in the
public/Databasefolder with your dbml file. - change the DatabaseName field in
src/config.jsonto the name of your dbml file. - Start the Site
yarn start
| Feature | Supported | Notes |
|---|---|---|
| Project Definition | ✔️ | |
| Table Definition | ✔️ | |
| Table Alias | ✔️ | |
| Table Notes | ✔️ | |
| Table Settings | ❌ | Not Yet Supported By DBML Standard |
| Column Definition | ✔️ | |
| Default Value | ✔️ | |
| Index Definition | ❌ | |
| Index Settings | ❌ | |
| Relationships | ☑️ | One to One Definitions Not Supported |
| Relationship Settings | ❌ | |
| Note Definition | ✔️ | Full Mardown Support of Project Note |
| Enum Definition | ❌ | |
| Table Groups | ❌ |
The 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.
Currently 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.