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

Allow alternate arrow syntax that doesn't close html comments #322

Closed
JimD2L opened this issue Mar 16, 2016 · 2 comments
Closed

Allow alternate arrow syntax that doesn't close html comments #322

JimD2L opened this issue Mar 16, 2016 · 2 comments

Comments

@JimD2L
Copy link

JimD2L commented Mar 16, 2016

I would like to include the mermaid syntax that generated a diagram inside a markdown file that references a rendered image of it. The traditional way to put a comment in a markdown file is to place it within an <!-- html comment -->. This doesn't work because mermaid link syntax closes the comment.

For now I am using the thicker links via ==>, but this is not an idea solution. An alternate link syntax would solve this issue. For example, __> or >>>.

@tylerlong
Copy link
Collaborator

I don't think there are any ideal solutions. Either it has conflicts with HTML or it's hard to read.

I do have the plan to rework the syntax(in a breaking change manner.) But let's close this issue for now.

@manulera
Copy link

Hello, I have the same problem, where I wanted to comment out a graph but it's just impossible. Had to switch to ==> as well. I think the easiest solution would be to add a synonym to --> with another character at the tip --^ or something that does not conflict with the existing options listed above this header:

https://mermaid.js.org/syntax/flowchart.html#special-characters-that-break-syntax

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants