marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-11-19 12:14:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge from master with doc updates

Browse Source
This commit is contained in:
Knut Sveidqvist
2020-07-16 12:27:03 +02:00
parent fec1553041 a1d2208bf3
commit da8e75f98a
22 changed files with 466 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/mermaidAPI.js
View File

@@ -1,7 +1,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**](https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#render) function which, given a graph
* The core of this api is the [**render**](Setup.md?id=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 somewhere in the page or do something completely different.