Skip to content

[CT-1452] Support mermaid in markdown #338

Closed as not planned
Closed as not planned
@il-dat

Description

@il-dat

Describe the feature

I have seen many places where mermaid can rich the documentation very well.
That's why I've tried to utilize it within dbt project, but it doesn't work yet.

Additional context

  • dbt model doc
  • dbt macro doc
  • general doc

Who will this benefit?

  • dbt docs site will become richer with mermaid diagrams
  • open the door for programmatically generating the diagrams/flows within md files, even use it for building ERD
    Sample mermaid for ERD:
erDiagram
    CUSTOMER ||--o{ ORDER : places
    CUSTOMER {
        string name
        string custNumber
        string sector
    }
    ORDER ||--|{ LINE-ITEM : contains
    ORDER {
        int orderNumber
        string deliveryAddress
    }
    LINE-ITEM {
        string productCode
        int quantity
        float pricePerUnit
    }

Metadata

Metadata

Assignees

No one assigned

    Labels

    StaleenhancementNew feature or requesthelp_wantedTrickier changes, with a clear starting point, good for previous/experienced contributorstriage

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions