docs(mermaid): document the controls, fullscreen and align arguments#107
Merged
Conversation
70db935 to
cba0811
Compare
Contributor
Author
|
🎉 This PR is included in version 1.14.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
Summary
The mermaid component page stated "The shortcode does not support any arguments" — stale, since it now supports
controls,fullscreen, andalign.Replace that with:
{{< args structure="mermaid" group="shortcode" >}}), which renders from mod-mermaid'sdata/structures/mermaid.yml—controlsandaligninherit their canonical mod-utils definitions,fullscreenis mermaid-specific;{{< mermaid controls=true fullscreen=true >}}.Uses the same
{{< args … >}}pattern as the other component pages (e.g.button) and the same{{</* mermaid */>}}escaping as the page's existing diagram examples.