GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

Update mermaidAPI.md

Browse Source
This commit is contained in:
Neil Cuzon 2020-03-10 19:16:24 -07:00 committed by GitHub
parent e6910d3c52
commit 71e0a788d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/mermaidAPI.md
View File

@ -2,13 +2,14 @@
## mermaidAPI
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.
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, renders the given text based input to a graph/diagram, that is returned as an svg element.
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.
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.
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.
In addition to the render function, a number of behavioral configuration options are also available.
In addition to the render function, a number of behavioral configuration options are available.
## Configuration