Skip to content

A Standalone Site for Displaying Database Documentation Based on DBML Files

License

Notifications You must be signed in to change notification settings

IllusiveBagel/DBMLDocs

Repository files navigation

DBML Docs

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.

Live Demo (Coming Soon)

How to Use

  1. Clone Repo
git clone https://github.com/IllusiveBagel/DBMLDocs.git
  1. Install Dependencies
yarn install
  1. Replace Example.dbml in the public/Database folder with your dbml file.
  2. change the DatabaseName field in src/config.json to the name of your dbml file.
  3. Start the Site
yarn start

Supported Features

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

DBML Documentation

About Example.dbml

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.