Skip to content

docs(mermaid): document the controls, fullscreen and align arguments#107

Merged
markdumay merged 1 commit into
mainfrom
feat/document-mermaid-controls
Jul 5, 2026
Merged

docs(mermaid): document the controls, fullscreen and align arguments#107
markdumay merged 1 commit into
mainfrom
feat/document-mermaid-controls

Conversation

@markdumay

Copy link
Copy Markdown
Contributor

Summary

The mermaid component page stated "The shortcode does not support any arguments" — stale, since it now supports controls, fullscreen, and align.

Replace that with:

  • the auto-generated args table ({{< args structure="mermaid" group="shortcode" >}}), which renders from mod-mermaid's data/structures/mermaid.ymlcontrols and align inherit their canonical mod-utils definitions, fullscreen is mermaid-specific;
  • a live example showing {{< 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.

@markdumay markdumay force-pushed the feat/document-mermaid-controls branch from 70db935 to cba0811 Compare July 5, 2026 10:02
@markdumay markdumay enabled auto-merge July 5, 2026 10:02
@markdumay markdumay merged commit 402d580 into main Jul 5, 2026
8 checks passed
@markdumay markdumay deleted the feat/document-mermaid-controls branch July 5, 2026 10:03
@markdumay

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 1.14.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant