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

Mermaid-cli arguments option and flexible HTML detection #14

Open
wants to merge 10 commits into
base: mermaid-cli
Choose a base branch
from

Conversation

nbanyan
Copy link

@nbanyan nbanyan commented Jul 8, 2024

  • Added option 'mermaid_args' to be able to specify arguments sent to mermaid-cli.
  • Expanded mermaid HTML element detection. Now accepts any HTML element with a 'mermaid' or 'language-mermaid' class and at most one child HTML element.
    • <pre class="mermaid">
    • <code class="mermaid"><pre>
    • <div class="mermaid">
  • Added option 'mermaid_img_scale_reduction' to counter the increase in visual size caused by mmdc argument --scale. Using both at the same value (i.e., 4) allows higher resolution diagrams at the native size.
  • Suppress mmdc sub-process chatter when using '--quiet'

Nathaniel Clark added 10 commits July 8, 2024 14:10
arguments sent to mermaid-cli.

Also expanded mermaid HTML element detection.

I used PyMdown Extension SuperFences for my Mermaid diagrams
in  MkDocs, so my HTML is still the old `<div class="mermaid">` blocks.
Therefore, I used regex to detect any HTML block with the `mermaid`
or `language-mermaid` class with at most one child HTML element.
mermaid_img_scale_reduction uses CSS height and width
to scale down the visual size of rendered mermaid diagrams.
This is a direct counter to puppeteer scale fed to
mermaid-cli so that setting both to the same
integer larger than 1 will result in a higher resolution
diagram at the natural 'scale 1' visual size.
…er application of additional CSS rules like 'width=100%'.
…age's style attribute if the image's attributes don't need to be fixed.
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.

1 participant