Skip to content

add support for mermaid.js #134

@rsteph-de

Description

@rsteph-de

I want to support mermaid.js diagramms in our documentation ...

Mermaid lets you create diagrams and visualizations using text and code.
It is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.

Syntax: https://mermaid.js.org/intro/syntax-reference.html

The integration is easy,

I'll provide a shortcode for integration. It can be used as follows:

{{< mcr-figure label="Klassendiagramm" caption="MCRContent" >}}
{{< mcr-mermaid >}}
classDiagram
class MCRContent {
  <<abstract>>
  #String name
  + InputStream getInputStream()*
  + Document asXML()
  + MCRContent ensureXML()
  + byte[] asByteArray()
}
class MCRXMLContent {
<<abstract>>
+ MCRXMLContent MCRXMLContent()
}
MCRContent <|-- MCRXMLContent
class MCRJDOMContent {
+ MCRJDOMContent(Document)
+ MCRJDOMContent(Element)
}
MCRXMLContent <|-- MCRJDOMContent
{{< /mcr-mermaid >}}
{{< /mcr-figure >}}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions