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

Remove unsupported backticks #159

Open
wants to merge 1 commit into
base: movermeyer/python_313_support
Choose a base branch
from

Conversation

movermeyer
Copy link
Collaborator

@movermeyer movermeyer commented Nov 10, 2024

What are you trying to accomplish?

Sen on the Why ciso8601? page:

Screenshot 2024-11-09 at 22 16 23

Previously, one could include backticks in their node labels. However, Mermaid v10.1.0 introduced "Markdown formatting" (which despite its name is not Markdown, but just Markdown-style bold and italics) which uses the backticks as part of its delimiters. This broke these labels.


Screenshot 2024-11-09 at 22 35 44

Also the "no" edges were being rendered as "n".

What approach did you choose and why?

I've changed the labels to no longer use the backticks. 🤷
I quoted the no edge labels, so they render correctly.

What should reviewers focus on?

🤷. CI is failing due to unrelated issues (fixed in #158)

The impact of these changes

Node/edge labels will render correctly once again.

Testing

You can visit https://github.com/closeio/ciso8601/blob/movermeyer/diagram_fixup/why_ciso8601.md and see the rendered page with the fixes:

Screenshot 2024-11-09 at 22 40 23

@movermeyer movermeyer marked this pull request as ready for review November 10, 2024 03:38
Previously, one could include backticks in their node labels. However, Mermaid v10 introduced "Markdown formatting" (which despite its name is not Markdown, but just Markdown-style bold and italics) which uses the backticks as part of its delimiters. This broke these labels.

I've changed the labels to no longer use the backticks. 🤷
@movermeyer movermeyer changed the base branch from master to movermeyer/python_313_support November 10, 2024 21:40
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

Successfully merging this pull request may close these issues.

1 participant