kino_kroki v0.1.0

View Source Kino.Kroki.Samples (kino_kroki v0.1.0)

Parses and makes samples easy to access.

Samples for the following diagram types are available:

  • actdiag
  • blockdiag
  • bpmn
  • bytefield
  • c4plantuml
  • ditaa
  • erd
  • excalidraw
  • graphviz
  • mermaid
  • nomnoml
  • nwdiag
  • packetdiag
  • pikchr
  • plantuml
  • rackdiag
  • seqdiag
  • structurizr
  • svgbob
  • vega
  • vegalite
  • wavedrom

Link to this section Summary

Types

type()

Functions

all()

Return all the samples

get(type)

Fetch a sample by diagram type

Link to this section Types

Link to this type

type()

View Source 
@type type() ::
  :wavedrom
  | :vegalite
  | :vega
  | :svgbob
  | :structurizr
  | :seqdiag
  | :rackdiag
  | :plantuml
  | :pikchr
  | :packetdiag
  | :nwdiag
  | :nomnoml
  | :mermaid
  | :graphviz
  | :excalidraw
  | :erd
  | :ditaa
  | :c4plantuml
  | :bytefield
  | :bpmn
  | :blockdiag
  | :actdiag

Link to this section Functions

Link to this function

all()

View Source 
@spec all() :: map()

Return all the samples

Link to this function

get(type)

View Source 
@spec get(type :: String.t() | type()) :: String.t() | nil

Fetch a sample by diagram type