Feature Release: Built-in Markdown Editor for table/field notes

News from dbx
1

Markdown-supported notes are highly useful in helping document readers understand database structures. However, creating great documentation is tough and time-consuming because it necessitates rebuilding the entire project whenever you wish to add a useful explanation to a table or field.

Today, we are pleased to announce our built-in Markdown Editor for table/field notes, which will make documentation writing easier.

Here are some highlights of the feature:

  • :white_check_mark: Quick and easy way to add helpful descriptions to existing documentation.
  • :white_check_mark: Inspired-by-WYSIWYG editor, friendly with non-technical users without Markdown syntax knowledge.

dbdocs-markdown-editor

This feature is available to all dbdocs users, both free and paid. Feel free to give it a try and let us know what you think.

For the latest update on new features, make sure to follow us on our social media: :bird: X (TWITTER) - :luggage: LINKEDIN

Thank you for your continued support and trust in our products.

From dbx team with :heart:

1 Like
2

@Thi_Nguyen this is a great feature. One thing I’m missing (not sure if I haven’t found it or it’s not there): if I use the GUI to add comments, these are not synced back to my dbdiagram DBML.

So I would need to export from dbdocs and then import that into dbdiagram.

That seems very cumbersome - is there a two-way sync between the two tools? (or a way to enable a dbdiagram-style editor inside dbdocs)

3

I’m glad that you liked the feature.

Indeed, new changes in dbdocs will not be synced back to dbdiagram at this time. We plan to add a dbdiagram-style editor for dbdocs in the near future. It is one of the key features that will combine dbdiagram and dbdocs into a unified product.

1 Like