Quarto Diagrams - Mermaid documentation

[rmcd-mscb]

This is a small issue.

As a new quarto user, the following text in the diagrams documentation eluded me in that I kept using the //| rather than %%/ in a mermaid block to define a figure caption.

Note that the cell options syntax is slightly different for {mermaid} and {dot} (%%| and //|, respectively) because they have distinct character sequences for single-line comments.

Suggest adding it as a call out for more emphasis and perhaps adding an example of adding a figure caption to a mermaid block.

[cscheid]

For what's worth, we do have mermaid metadata block examples in the Sizing and Echo sections.

[rmcd-mscb]

Yup - thanks Carlos. It's all there :) Still I think adding that text describing the difference in options syntax in a call out, you already have "Note" in the text, may help some other newbies :)

[cscheid]

We are intentionally conservative about adding callouts, because they compete with one another for visual attention.

With that said, I did change the page to describe the comment syntax for mermaid and graphviz diagrams, and that should be updated shortly.

[rmcd-mscb]

Thank you Carlos.