README
V
render

pele

A MoonBit port of pele, a Mermaid to SVG renderer

mermaid

svg

Download zip

Author

Omochice

Version

0.2.0

License

Zlib AND MIT

Repository

github.com/Omochice/pele.mbt

Last updated

12 hours ago

Downloads

No dependencies

#pele

A MoonBit port of pele, which renders Mermaid diagrams to SVG.

The port draws the same SVG as pele byte for byte, or fails with the same error.

#Usage

moon add Omochice/pele

@pele.render recognizes every diagram type.

let source =
  #|graph TD
  #|  A --> B
let result = @pele.render(source)
println(result.svg)

@pele used in the above example requires import in moon.pkg.

import {
  "Omochice/pele",
}

#Picking diagram types

Linking every diagram type makes a program larger, which matters for a wasm build. @core.render recognizes only the diagram types it is given. Each type is the value of the same name in its package under Omochice/pele/diagrams/.

let source =
  #|graph TD
  #|  A --> B
let result = @core.render(
  [@flowchart.flowchart, @pie.pie],
  source,
  @types.RenderOptions::default(),
)
println(result.svg)

@core, @types, @flowchart and @pie used in the above example each require import in moon.pkg.

import {
  "Omochice/pele/core",
  "Omochice/pele/diagrams/flowchart",
  "Omochice/pele/diagrams/pie",
  "Omochice/pele/types",
}

#License

The port is licensed under the zlib License in LICENSE.

It is derived from pele. pele's MIT License is kept in LICENSE-PELE.

render

source

fn render(source : String, options? : @Omochice/pele/types.RenderOptions
RenderOptions) -> @Omochice/pele/types.RenderResult
RenderResult raise @Omochice/pele/errors.PeleError
PeleError

Renders Mermaid text to SVG, recognizing every diagram type the port supports. @core.render renders with only the diagram types it is given, which keeps the other types out of a program. Raises PeleError for text pele rejects.