marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-18 14:59:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Clarification

Browse Source
This commit is contained in:
erelling
2019-08-28 21:55:35 +02:00
committed by GitHub
parent d3f7923bc6
commit 187ddfd80c
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/mermaidAPI.md
View File

@@ -2,13 +2,13 @@
## mermaidAPI ## mermaidAPI
This is the api to be used when handling the integration with the web page instead of using the default integration 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.
(mermaid.js).
The core of this api is the [**render**](https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#render) 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**](https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#render) function which, given a graph definition as text, renders the graph/diagram and returns an svg element for the graph.
It is is then up to the user of the API to make use of the svg, either insert it 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.
somewhere in the page or do something completely different.
In addition to the render function, a number of behavioral options are available.
## Configuration ## Configuration