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

Markdown lists are not supported #6099

Open
Timac opened this issue Nov 29, 2024 · 0 comments
Open

Markdown lists are not supported #6099

Timac opened this issue Nov 29, 2024 · 0 comments
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect

Comments

@Timac
Copy link
Contributor

Timac commented Nov 29, 2024

Description

Markdown lists are not supported in Mermaid diagrams. When using a Markdown list in a diagram, you will see the error Unsupported markdown: list

Steps to reproduce

Example with '-'

  1. Create a graph using a Markdown list
flowchart LR
    A[Node 1] --> B["`- Line1
    - Line 2
    - Line 3`"]
  1. You see the error Unsupported markdown: list when the graph is rendered:
flowchart LR
    A[Node 1] --> B["`- Line1
    - Line 2
    - Line 3`"]
Loading

Example with '*'

  1. Create a graph using a Markdown list
flowchart LR
    A[Node 1] --> B["`* Line1
    * Line 2
    * Line 3`"]
  1. You see the error Unsupported markdown: list when the graph is rendered:
flowchart LR
    A[Node 1] --> B["`* Line1
    * Line 2
    * Line 3`"]
Loading

Setup

  • Mermaid version: 11.4.1
  • Browser and Version: Reproduced with Chrome and Safari

Workaround

A workaround is not to use characters like or :

flowchart LR
    A[Node 1] --> B["`• Line1
    • Line 2
    • Line 3`"]

is rendered as

flowchart LR
    A[Node 1] --> B["`• Line1
    • Line 2
    • Line 3`"]
Loading
flowchart LR
    A[Node 1] --> B["`- Line1
    - Line 2
    - Line 3`"]

is rendered as

flowchart LR
    A[Node 1] --> B["`- Line1
    - Line 2
    - Line 3`"]
Loading
@Timac Timac added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

No branches or pull requests

1 participant