From fff29fcd69569551fda3064a0510d9583ff67b8f Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Sun, 8 Nov 2020 01:29:00 -0800 Subject: [PATCH] Update Setup.md --- docs/Setup.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/Setup.md b/docs/Setup.md index c71eda826..2ce0bb003 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -5,7 +5,7 @@ This is the api to be used when optionally handling the integration with the web page, instead of using the default integration provided by mermaid.js. The core of this api is the [**render**][1] function which, given a graph -definition as text, renders the graph/diagram and returns an svg element for the graph. +definition, renders a graph/diagram and returns it as an svg element. It is is then up to the user of the API to make use of the svg, either insert it somewhere in the page or do something completely different. @@ -111,9 +111,15 @@ Note: modifies options in-place - `conf` the base currentConfig to reset to (default: current siteConfig ) (optional, default `getSiteConfig()`) -## render +## mermaid.API Functions -Function that renders an svg with a graph from a chart definition. Usage example below. +- `mermaidAPI.initialize` is a call to the mermaid API, that targets `config` and changes the before the diagram is rendered. + +**Notes**: `Config` is a variable that contains various configurable elements that can alter how the rendered SVG Diagram/Chart will look like. + +- `mermaidAPI.render` is function that renders a graph/diagram in svg format, from a chart definition inside `