Mermaid Rendering

Mermaid Options (mermaid)

Defines optional settings for overriding site configuration for the Mermaid diagrams markup, which enables you to use Mermaid to create diagrams in your content with mermaid codeblock rendering hook.

With Mermaid, you can create numerous diagrams including flowcharts, pie charts, and sequence diagrams.

JSON Schema

Definition
{
  "$id": "https://platen.io/modules/platen/config/content/markup/mermaid/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Optional settings for overriding Mermaid configuration on a content page.\n\nhttps://platen.io/modules/platen/config/content/markup/mermaid/",
  "properties": {
    "version": {
      "description": "Specify the version of Mermaid to load for this content.\n\nhttps://platen.io/modules/platen/config/content/markup/mermaid/#version",
      "title": "Mermaid Version",
      "type": "string"
    }
  },
  "title": "Mermaid Options",
  "type": "object"
}

Mermaid Version (version)

Specifies the version of Mermaid to load when needed, overriding the site-level setting. Platen retrieves the style and script modules for Mermaid from a CDN at build time. This value is used to determine which version to bundle and use for this content.

You can set this value to any valid released version of Mermaid.

Edit this page