Skip to content

showing flowcharts in documents (Mermaid) #9726

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

Open
keyhanjk opened this issue Apr 15, 2025 · 3 comments
Open

showing flowcharts in documents (Mermaid) #9726

keyhanjk opened this issue Apr 15, 2025 · 3 comments
Assignees
Labels
bug Issue is reported as a bug team:VM Assigned to OTP team VM

Comments

@keyhanjk
Copy link
Contributor

keyhanjk commented Apr 15, 2025

for example we have charts in this page
https://www.erlang.org/doc/apps/kernel/logger_chapter.html
but show only source code

Chart in document:

---
title: Conceptual Overview
---
flowchart TD
    DB[(Config DB)]
    API ---> ML[Module Level <hr> Global Level <hr> Global Filters]
    API -.Update configuration.-> DB
    ML -.-> DB
    ML ---> HL1[Hander Level <hr> Handler Filter]
    ML ---> HL2[Hander Level <hr> Handler Filter]
    HL1 ---> HC1[Handler Callback]
    HL2 ---> HC2[Handler Callback]
    HL1 -.-> DB
    HL2 -.-> DB
    subgraph Legend
        direction LR
        start1[ ] -->|Log event flow| stop1[ ]
        style start1 height:0px;
        style stop1 height:0px;
        start2[ ] -.->|Look up configuration| stop2[ ]
        style start2 height:0px;
        style stop2 height:0px;
    end

Behaviour:
show only source codes

Expected:
Image

@keyhanjk keyhanjk added the bug Issue is reported as a bug label Apr 15, 2025
@garazdawi
Copy link
Contributor

Does it work if you reload the page?

@garazdawi garazdawi self-assigned this Apr 15, 2025
@keyhanjk
Copy link
Contributor Author

keyhanjk commented Apr 15, 2025

Does it work if you reload the page?

yes, after reloading it works

@garazdawi
Copy link
Contributor

Then it is #9346 that needs to be backported to maint-27 for the website to use it. Basically there is an issue when navigating to a page that the mermaid renderer is not triggered as it should be. Doing a reload triggers the rendering and makes everything work again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue is reported as a bug team:VM Assigned to OTP team VM
Projects
None yet
Development

No branches or pull requests

3 participants