Multi-line title in all mermaid diagrams

[alex-papaioannou]

Hello everyone, I hope you are doing well. Do you think it would be possible to enable multi-line titles in all diagrams using the <br> tag?

Summary:

• Enable the use of <br> within Mermaid titles to allow multiline text. This provides a straightforward, backward-compatible way to improve readability for longer or multiple-part titles.

Rationale:

• Clarity: Diagrams often need detailed or multi-part titles (e.g., title and subtitle).
• Consistency: Many Markdown/HTML tools already interpret <br> for line breaks.
• Simplicity: Minimal changes—only parse <br> as a line break within the existing title syntax.

Proposed Implementation:

• Extend the parsing of the title keyword to detect <br> tags and render them as newlines.
• Continue to treat titles without <br> tags as single-line.
• Maintain backward compatibility—no breaking changes.

Example

---
title: An Example Flowchart Title <br> With a Subtitle
---
flowchart LR
    A[Start] --> B{Decision?}
    B -->|Yes| C[Continue]
    B -->|No| D[Stop]

Loading

Screenshots