Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT] dbt docs serve mermaid #105

Open
mattiasthalen opened this issue Apr 24, 2024 · 1 comment
Open

[FEAT] dbt docs serve mermaid #105

mattiasthalen opened this issue Apr 24, 2024 · 1 comment
Labels
wontfix This will not be worked on

Comments

@mattiasthalen
Copy link

Is your feature request related to a problem? Please describe.
Not a problem, more of an enhancement.

Describe the solution you'd like
Have it modify manifest.json to include the mermaid code into the docs.
It should probably be added as a description for all tables in the model.

@datnguye
Copy link
Owner

datnguye commented Apr 25, 2024

Thanks @mattiasthalen for raising the feat!

It makes sense with your request, and I really love to have it as soon as possible.
However I don't think this feature will be in-scope for this tool, dbterd (at least for now). As of now, my only suggestion is to raise an issue to https://github.com/dbt-labs/dbt-docs for the ERD enrichment instead. Or let's build the Python script helper to handle this stuff.

Looking forward to seeing your thoughts as further. Thanks!

For addtional info, dbt docs site seems not to support Mermaid (as a code) in markdown (dbt-labs/dbt-docs#338). So the only way now is to render the images and attach them into the docs site.

@datnguye datnguye added wontfix This will not be worked on and removed triage labels May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants