Use <output> and <pre> to format mermaid errors
#1496
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 996a20d. A better way to do fix this bug would be to not parse the syntax error as HTML in the first place.
Use the `<output>` and `<pre>` HTML elements to format mermaid errors, instead just adding the error message as HTML. Using `<pre>` avoids the need for sanitizing any HTML (or using a `monospace` font in CSS, since `<pre>` does this automatically). Using `<output>` means that users using screenreaders should have a better experience when using the mermaid live editor. on-behalf-of: @Mermaid-Chart <[email protected]>
✅ Deploy Preview for mermaidjs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
Use the
<output>and<pre>HTML elements to format mermaid errors, instead of just adding the error message as HTML.📏 Design Decisions
Using
<pre>avoids the need for sanitizing any HTML (or using amonospacefont in CSS, since<pre>does this automatically). It also prevents line-wrapping, which is good, since JISON errors rely on mono-spaced non-line-wrapped code, as they're pre-formatted.Using
<output>means that users using screen-readers should have a better experience when using the mermaid live editor.📋 Tasks
Make sure you
developbranch