marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-07 01:26:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update mermaidAPI.md

Browse Source
This commit is contained in:
Neil Cuzon
2020-03-05 17:34:06 -08:00
committed by GitHub
parent a0b1d16e79
commit 1570ed4610
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/mermaidAPI.md
View File

@@ -2,14 +2,13 @@
## mermaidAPI
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.
This API can be used optionally handle the integration of mermaid to a web page, instead of using the default integration methods 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.
The core of this api is the [**render**][1] function which, renders the given text based input to a graph/diagram, that is returned 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.
After it is rendered, it is is then up to the user of the API to make use of the svg, which can be either inserted somewhere in the page or something else altogether.
In addition to the render function, a number of behavioral configuration options are available.
In addition to the render function, a number of behavioral configuration options are also available.
## Configuration