{"id":20238793,"url":"https://github.com/openpotato/sqldocs","last_synced_at":"2026-04-21T17:38:31.491Z","repository":{"id":184467984,"uuid":"671938282","full_name":"openpotato/sqldocs","owner":"openpotato","description":"A cross-platform console application build with .NET 8 to create nice looking schema documentations for SQL databases. ","archived":false,"fork":false,"pushed_at":"2023-11-21T11:26:19.000Z","size":140,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-14T01:16:07.998Z","etag":null,"topics":["dotnet","sql","sqldocs"],"latest_commit_sha":null,"homepage":"https://github.com/openpotato/sqldocs/wiki","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openpotato.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-28T13:47:14.000Z","updated_at":"2024-07-04T11:34:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"73f4a88b-a53a-446f-8482-8a7d50e1c471","html_url":"https://github.com/openpotato/sqldocs","commit_stats":null,"previous_names":["openpotato/sqldocs"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fsqldocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fsqldocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fsqldocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openpotato%2Fsqldocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openpotato","download_url":"https://codeload.github.com/openpotato/sqldocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241685746,"owners_count":20003102,"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":["dotnet","sql","sqldocs"],"created_at":"2024-11-14T08:35:45.010Z","updated_at":"2026-04-21T17:38:31.452Z","avatar_url":"https://github.com/openpotato.png","language":"C#","readme":"\u003cdiv align=\"center\"\u003e\n  \n# SQLDocs\n\n[![.Net](https://img.shields.io/badge/.NET-5C2D91?style=for-the-badge\u0026logo=.net\u0026logoColor=white)](https://dotnet.microsoft.com/)\n[![GitHub License](https://img.shields.io/github/license/openpotato/sqldocs?style=for-the-badge)](./LICENSE)\n[![Documentation](https://img.shields.io/badge/docs-available-brightgreen?style=for-the-badge)](https://github.com/openpotato/sqldocs/wiki)\n\n\u003c/div\u003e\n\nSQLDocs is a cross-platform console application build with [.NET 10](https://dotnet.microsoft.com/) to create nice looking [MkDocs](https://www.mkdocs.org/) schema documentations for relational databases. Currently the following database systems are supported:\n\n+ [Firebird](https://firebirdsql.org/)\n+ [PostgreSQL](https://www.postgresql.org/)\n\nSQLDocs 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.). \n\nIn a second step, the information from the JSON file is used to create or update a MkDocs project (with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) as theme).\n\nBoth the JSON file and the MkDocs project can be versioned in a Git repository.\n\n## Examples\n\nIf you would like to see what documentation created with SQLDocs looks like:\n\n+ [Sample documentation for a Firebird database](https://openpotato.github.io/sqldocs.sample/firebird)\n+ [Sample documentation for a PostgreSQL database](https://openpotato.github.io/sqldocs.sample/postgres)\n\n## Documentation\n\nDocumentation is available in the [GitHub wiki](https://github.com/openpotato/sqldocs/wiki).\n\n## To-do list\n\n+ Support for additional DBMS (e.g. MySQL or MS SQL Server)\n+ Support for additional table types (e.g. external tables, temporary tables)\n+ Support for domains and custom types\n+ Support for generators/sequences\n+ Support for triggers\n+ Support for stored procedures\n+ (Maybe) support for alternative static-site generators (e.g. [Docusaurus](https://docusaurus.io/))\n\n## Can I help?\n\nYes, 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.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpotato%2Fsqldocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenpotato%2Fsqldocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpotato%2Fsqldocs/lists"}