SQLDocs is a cross-platform console application build with .NET 8 to create nice looking MkDocs schema documentations for relational databases. Currently the following database systems are supported:
SQLDocs first extracts the metadata of the desired database and stores it in a normalised JSON file. This JSON file can be manually extended with additional information (descriptions, valid data values, etc.).
In a second step, the information from the JSON file is used to create or update a MkDocs project (with Material for MkDocs as theme).
Both the JSON file and the MkDocs project can be versioned in a Git repository.
If you would like to see what documentation created with SQLDocs looks like:
Documentation is available in the GitHub wiki.
- Support for additional DBMS (e.g. MySQL or MS SQL Server)
- Support for additional table types (e.g. external tables, temporary tables)
- Support for domains and custom types
- Support for generators/sequences
- Support for triggers
- Support for stored procedures
- (Maybe) support for alternative static-site generators (e.g. Docusaurus)
Yes, that would be much appreciated. The best way to help is to post a response via the Issue Tracker and/or submit a Pull Request.