Home

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:

• Firebird
• PostgreSQL

SQLDocs works as follows:

• Step 1: SQLDocs extracts the schema (tables, views, indices, primary keys, foreign keys etc.) of the desired database and stores it in a normalised JSON file.

• Step 2: This JSON file can be manually extended with additional information (descriptions, valid data values, etc.).

• Step 3: SQLDocs uses the the information from the JSON file to create a new MkDocs project (with Material for MkDocs as theme) or to update it.

• Step 4: Build the MkDocs project and you can see the result.

Some notes:

• The created MkDocs project has the following dependencies:

  • Material for MkDocs as theme.
  • MkDocs Awesome Pages Plugin to define navigation outside of mkdocs.yml.

• If it is the first time, a completely new MkDocs project is created. For subsequent calls of SQLDocs, only the files below the database folder are changed. This means that the file mkdocs.yml as well as all Markdown files outside the folder database can be adapted or edited without SQLDocs overwriting them.

• Descriptions (e.g. for table columns) support a limited number of HTML tags (bold, italic and code) and internal links to other database objects (tables, views and schemas).

• 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:

• Sample documentation for a Firebird database + Source Code
• Sample documentation for a PostgreSQL database + Source Code