Document escaping conflicting Mermaid syntax - #2911
Open
nightcityblade wants to merge 1 commit into
Open
Conversation
Member
|
Hi @nightcityblade , thanks for your PR! We have a comprehensive PR template that we do require contributors to use. |
Author
|
Thanks for the reminder. I’ve updated the PR description using the repository’s complete template and filled each applicable section and checklist item. |
This file contains hidden or 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
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.
What is the purpose of this pull request?
Fixes #2550
Overview of changes:
raw/endrawescaping guidance.This documents how authors can use Mermaid directives containing conflicting braces without build or rendering errors.
Anything you'd like to highlight/discuss:
The example uses MarkBind's supported Nunjucks string-expression escape syntax so the Mermaid initialization directive reaches Mermaid unchanged.
Testing instructions:
No special setup is required. Build the user guide with
npm run build:ugand inspect the Mermaid plugin page.Validation already run:
npm run build:backendnpm run build:ug(41 pages built successfully; existing unrelated intra-link warnings remain)git diff --checkProposed commit message: (wrap lines at 72 characters)
docs: explain escaping Mermaid syntax
Checklist: ☑️
Reviewer checklist:
Indicate the SEMVER impact of the PR:
At the end of the review, please label the PR with the appropriate label:
r.Major,r.Minor,r.Patch.Breaking change release note preparation (if applicable):