View Source Kino.Mermaid (Kino v0.14.2)

A kino for rendering Mermaid diagrams.

Relation to Kino.Markdown

Mermaid diagrams can also be generated dynamically with Kino.Markdown, however the output of Kino.Markdown is never persisted in the notebook source. Kino.Mermaid doesn't have this limitation.

Examples 

Kino.Mermaid.new("""
graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;
""")

Summary

Types

t()

Functions

new(diagram, opts \\ [])

Creates a new kino displaying the given Mermaid diagram.

Types

Link to this type

t()

View Source 
@type t() :: Kino.JS.t()

Functions

Link to this function

new(diagram, opts \\ [])

View Source 
@spec new(
  binary(),
  keyword()
) :: t()

Creates a new kino displaying the given Mermaid diagram.

Options

  • :caption - an optional caption for the rendered diagram.

  • :download - whether or not to show a button for downloading the diagram as a SVG. Defaults to true.