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

#256 Fix rendering issue in "Langium's workflow" flowchart #258

Merged

Conversation

MarianPalkus
Copy link
Contributor

This PR addresses #256.

The rendering issues might be caused by markdown numbered list recognition in flow chart nodes (e.g. 1. Install Yeoman).

Escaping the . as proposed here, i.e. 1\. Install Yeoman, did not work for me (Safari 17.6):
Screenshot 2024-10-29 at 08 49 28

As a workaround this PR adds a non-breaking space to prevent numbered lists, e.g. 1. Install Yeoman.

This seems to fix the rendering issue (tested on Safari 17.6):
Screenshot 2024-10-29 at 08 40 40

Additionally, the flow chart node for each additional\ngrammar change seems to not render the line break as intended.
Replacing \n with <br/> results in a proper line break (Safari 17.6):

Screenshot 2024-10-29 at 08 41 45

…own: list"

Updated the steps in the workflow flowchart to use non-breaking spaces to prevent recognition of markdown numbered lists which is not supported by mermaid.
Replaced `\n` with `<br/>` in the mermaid flowchart diagram to ensure proper line breaks in the rendered HTML.
Copy link

github-actions bot commented Oct 29, 2024

PR Preview Action v1.4.6
Preview removed because the pull request was closed.
2024-10-29 14:54 UTC

Copy link
Member

@msujew msujew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @MarianPalkus!

@msujew msujew merged commit 3a01e1e into eclipse-langium:main Oct 29, 2024
5 checks passed
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.

2 participants