Skip to content

Mermaid code in markdown exported AI Documentation #113

@Hjaf

Description

@Hjaf

Is your feature request related to a problem? Please describe.
When exporting the markdown version of the generated documentation the mermaid diagram is included as an image-file instead of the actual mermaid code used to generate the image. The embedded image-data in markdown is a bit difficult to manage.

Describe the solution you'd like
Either provide an option to choose markdown flavor spec or to include diagram code or not. E.g. if GitHub is selected the code is added to a ```mermaid ... infostring for fenced codeblocks.

Describe alternatives you've considered
Include the mermaid code in a commented section next to the image.

Additional context
Ability to make adjustments to mermaid-diagrams such as this very helpful, especially when committed as reviewable code!

Also: Perhaps the image data could be added as an reference at the end of the file like link reference definitions, to make it easier to read the raw markdown document.

GitHub documentation: Creating Mermaid diagrams

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions