Mermaid subgraph extra spaces

[cumiller]

I am having trouble getting a mermaid diagram in the xml comments to render on Azure DevOps. DevOps does not seem to like that the subgraph end of line has two spaces after it.

ex.:
::: mermaid
graph TD
A((Start))-->B
B-->A0

subgraph mySubgraph
A0{?}
A0-- Yes-->A1
A1-->C
A0-- No -->B0
B0-->C
end

W-->X((end))
:::

After "mySubgraph" there are two spaces which cause DevOps' mermaid engine to error. The generated xml comments file does not have spaces after "mySubgraph". Is this something DefaultDocumentation is putting in?

[Doraku]

Yeah, this is the markdown syntax for a line break :/

this (no '  ' at the end)
text

render like this in markdown

this (no ' ' at the end) text

Doing two line break instead of ' ' would generate a paragraphe, which is different from a normal line break.

Hum maybe I could add a custom balise like <raw> where the content is displayed as is without any reformatting. I will check if other documentation generators have something like this, if there is a precedent.

[cumiller]

Ok, I see. The mermaid commands are being seen as a text string and the double space is used to maintain the line breaks. DD would need a tag or delimiter to know that it is not a simple text string. Can the ::: ( and I've seen ```) used at the beginning and end of the mermaid diagram markup be used to signal to DD that it should be handled raw?

[cumiller]

Would you consider overriding the XElement.ToString() when writing out "br" elements?

MarkdownWrite WriteNodes()
"br" when isPreview => _builder.Append(element.ToString()), _ when isPreview => _builder, _ => _builder.Append(element.Name.ToString() == "br" ? "<br/>" : element.ToString())

If element is "br" then write as custom string "<br/>" otherwise, write using ToString().

[Doraku]

Hum this is probably because of the framework XElement parsing and ToString overload. I will see if there is an easier way to preserve your tag spacing.

[cumiller]

Where are you at on this? Can we get
written without inserting spaces?

[Doraku]

I just gave a quick look last week, sadly ICSharpCode.Decompiler return directly the documentation xml pre formatted losing whether you had a space or not and I don't think it is possible to change it, so I may have to replace this part completely. I am finally coming back home after 4 weeks of holidays/remote work so I will be in better disposition, sorry for the unproductive august month ^^"

[Doraku]

You should be able to declare

<code language="mermaid">
...
</code>

it will render as

```mermaid
...
```

which seem to work now on github at least.