Skip to content

✏️ Remove links from Mermaid diagram #867

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

Merged

Conversation

ebouchut
Copy link
Collaborator

@ebouchut ebouchut commented Oct 5, 2024

This PR fixes the Mermaid flowchart diagram an the text of nodes in the `README file.
It:

  • removes links (no longer functional)
  • replaces the star (*) and backtick (`) characters in the text nodes with HTML entities (resp. (*) and (``)) to prevent these characters from being interpreted.

These characters (* and `) were previously interpreted as regular text.
GitHub recently made a configuration change to enable Markdown by default in the text of a Node. They are now interpreted as the Markdown directives italic and inline code block.
The fix is to replace these characters with the appropriate HTML entity so that they are displayed literally.

Character When Replaced with this HTML Entity is rendered in a Text Node as
* * *
` ` `
Markdown in text Node Input Rendered Output
Disabled (previous default) *text* *text*
Disabled `text` `text`
Enabled (new default) *text* text
Enabled *text* *text*
Enabled `text` `text`

Add HTML entities for `*`, backtick to be displayed correctly in node text.

Links no longer work.
@ebouchut ebouchut added the typo Typo Fixes label Oct 5, 2024
@ebouchut ebouchut self-assigned this Oct 5, 2024
@ebouchut ebouchut merged commit 8a3b95f into LoopKit:main Oct 5, 2024
@ebouchut ebouchut deleted the fix/remove_links_from_mermaid_diagram branch October 5, 2024 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typo Typo Fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant