diff --git a/docs/mermaidAPI.md b/docs/mermaidAPI.md index b24009485..2dd9cea4b 100644 --- a/docs/mermaidAPI.md +++ b/docs/mermaidAPI.md @@ -5,9 +5,10 @@ This is the api to be used when handling the integration with the web page instead of using the default integration (mermaid.js). -The core of this api is the **render** function that given a graph definitionas text renders the graph/diagram and -returns a 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 something completely different. +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 +somewhere in the page or do something completely different. ## Configuration @@ -256,3 +257,51 @@ mermaidAPI.initialize({ - `container` selector to element in which a div with the graph temporarily will be inserted. In one is provided a hidden div will be inserted in the body of the page instead. The element will be removed when rendering is completed. + +## mermaidAPI defaults +``` + + + ```