Kolibry

Configure Mermaid

Environment: client
This setup function will only run on client side. Make sure the browser compatibility when importing packages.

Create ./setup/mermaid.ts with the following content:

import { defineMermaidSetup } from '@kolibry/types'

export default defineMermaidSetup(() => {
  return {
    theme: 'forest',
  }
})

With the setup, you can provide a custom default setting for Mermaid. Refer to the type definitions and its documentation for more details.

Custom theme/styles

In case you want to create your custom Mermaid themes or styles, you can do this by defining themeVariables like in the following example:

import { defineMermaidSetup } from '@kolibry/types'

export default defineMermaidSetup(() => {
  return {
    theme: 'base',
    themeVariables: {
      // General theme variables
      noteBkgColor: "#181d29",
      noteTextColor: "#F3EFF5cc",
      noteBorderColor: "#404551",

      // Sequence diagram variables
      actorBkg: "#0E131F",
      actorBorder: "#44FFD2",
      actorTextColor: "#F3EFF5",
      actorLineColor: "#F3EFF5",
      signalColor: "#F3EFF5",
      signalTextColor: "#F3EFF5",
    }
  }
})

You can find all theme variables on the Mermaid Theme Configuration page.