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

list of options? #100

Closed
kurokirasama opened this issue Dec 15, 2022 · 1 comment · Fixed by #116
Closed

list of options? #100

kurokirasama opened this issue Dec 15, 2022 · 1 comment · Fixed by #116

Comments

@kurokirasama
Copy link

Is there documentation about the options that can be put here:

{.mermaid options...}

like #fig:diag1, caption=,theme=andbackground=`?

@glgoose
Copy link

glgoose commented Jun 10, 2023

example usage

```{.mermaid width=100 format=png loc=img}
 sequenceDiagram
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
```

Taken from: https://github.com/raghur/mermaid-filter/blob/master/test.md?plain=1#L5-L9

options

option default
width 800
format png
loc inline
theme default
background white
caption ''
filename ''
scale 1
imageClass ''

Code reference:

mermaid-filter/index.js

Lines 29 to 37 in 97075a3

width: process.env.MERMAID_FILTER_WIDTH || 800,
format: process.env.MERMAID_FILTER_FORMAT || 'png',
loc: process.env.MERMAID_FILTER_LOC || 'inline',
theme: process.env.MERMAID_FILTER_THEME || 'default',
background: process.env.MERMAID_FILTER_BACKGROUND || 'white',
caption: process.env.MERMAID_FILTER_CAPTION || '',
filename: process.env.MERMAID_FILTER_FILENAME || '',
scale: process.env.MERMAID_FILTER_SCALE || 1,
imageClass: process.env.MERMAID_FILTER_IMAGE_CLASS || ''

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 a pull request may close this issue.

2 participants