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

Add MermaidJS plugin #11561

Open
antonpirker opened this issue Oct 14, 2024 · 0 comments
Open

Add MermaidJS plugin #11561

antonpirker opened this issue Oct 14, 2024 · 0 comments
Assignees
Labels
Improvement Type: Platform Issues about the platform & functionality of our docs

Comments

@antonpirker
Copy link
Member

Problem Statement

Graphs and diagrams in the docs (be it application or develop docs) are right now created in another tool, and then the image is linked in our docs.

This leads to outdated graphs everywhere.

Solution Brainstorm

It would be great if we could create/change Mermaid graphs directly in the .mdx files.

So it is possible to add something like this directly in the docs (develop and other docs) and the graph is rendered on the page:

'''mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
'''

(Those ''' should be back ticks (`) of course, dont know how to do this in github issues.)

The default styles of the graphs should also be updated, because right now mermaid graphs are not readable that good in dark mode. See:

@antonpirker antonpirker added Improvement Type: Platform Issues about the platform & functionality of our docs labels Oct 14, 2024
@chargome chargome self-assigned this Oct 14, 2024
@a-hariti a-hariti self-assigned this Oct 14, 2024
@chargome chargome removed their assignment Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Type: Platform Issues about the platform & functionality of our docs
Projects
Status: Backlog
Development

No branches or pull requests

3 participants