[Feature] Add Documentation Menu with Markdown Export for Database Documentation

[LuigimonSoft]

What

This pull request introduces a new "Documentation" menu item to the application, allowing users to export database documentation in Markdown format. The documentation is structured in a data dictionary format, including details such as table names, columns, constraints, indexes, and relationships.

Why

The purpose of this feature is to enhance the user experience by providing a streamlined way to generate and export database documentation in Markdown format. This allows users to easily share, review, and manage the database schema in a widely accepted and readable format.

How

• Add Documentation Menu:

  • A new menu item labeled "Documentation" has been added to the application's main menu.
  • Under the "Documentation" menu, an option labeled "Export as Markdown" has been included.

• Generate Markdown Documentation:

  • On selecting "Export as Markdown," a new window opens, displaying a preview of the database documentation in Markdown format.
  • The Markdown documentation is organized as follows:
    • Table Names: Each table in the database is clearly labeled.
    • Columns: For each table, the following details are listed:
      • Column Name
      • Data Type
      • Constraints (Primary Key, Foreign Key, Unique)
      • Default Values (if any)
      • Nullable (yes/no)
    • Relationships: Foreign key references and other relationships between tables are described.

• Export Functionality:

  • An "Export" button is provided in the Markdown preview window.
  • Upon clicking "Export," the Markdown file is downloaded to the user's machine.

close #228

[vercel]

@LuigimonSoft is attempting to deploy a commit to the dottle's projects Team on Vercel.

A member of the Team first needs to authorize it.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
drawdb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 31, 2024 8:05am

[1ilit]

This is a great feature. Thanks for the contribution.

Other than the comments, please move the dropdown to export as readme, I don't want people to think it's drawdb docs.

That should be pretty much it but I'll take a closer look at night

[1ilit]

Misclicked the approved sorry

[LuigimonSoft]

Than you for you feedback

[1ilit]

Just had a closer look. Idk why I just thought of it but you can also document the enums and types.

Thank you

[1ilit]

There's a missing plus sign between documentationTypes and \n\n that ends up throwing an error. Please test on postgres and add types before trying to export

[1ilit]

Looks good, thank you