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

Mermaid Diagrams Not Correctly Rendering Inline Markdown Formatting #472

Open
ranggakd opened this issue Nov 10, 2023 · 0 comments
Open
Labels
bug Something isn't working

Comments

@ranggakd
Copy link

📝 Provide detailed reproduction steps (if any)

  1. Create a new markdown file or open an existing one in your repository.
  2. Add the following Mermaid code block:
    ```mermaid
    %%{init: {"flowchart": {"htmlLabels": false}} }%%
    flowchart LR
        markdown["`This **is** _Markdown_`"]
        newLines["`Line1
        Line 2
        Line 3`"]
        markdown --> newLines
    ```
  1. Commit and push the changes to the repository.
  2. Open the markdown file in the GitHub web interface.

✔️ Expected result

The Mermaid diagram should be correctly rendered with the inline markdown formatting inside the nodes.

expected result

❌ Actual result

The Mermaid diagram is not correctly rendered when using inline markdown formatting. The markdown syntax inside the nodes is displayed as plain text.

actual result

%%{init: {"flowchart": {"htmlLabels": false}} }%%
flowchart LR
    markdown["`This **is** _Markdown_`"]
    newLines["`Line1
    Line 2
    Line 3`"]
    markdown --> newLines
Loading

❓ Possible Solution

There may be an issue with how GitHub's markdown renderer handles inline markdowns inside Mermaid diagrams. A possible solution could be to update the renderer to parse and display the inline markdown inside Mermaid diagrams correctly.

📃 Other details

  • Browser: Microsoft Edge - Version 119.0.2151.44 (Official build) (64-bit)
@ranggakd ranggakd added the bug Something isn't working label Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant