From 1570ed4610bbfc9ec1c3a331f2ad1f7038d21f51 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Thu, 5 Mar 2020 17:34:06 -0800 Subject: [PATCH] Update mermaidAPI.md --- docs/mermaidAPI.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/mermaidAPI.md b/docs/mermaidAPI.md index 7b7b68e06..bd4f3787f 100644 --- a/docs/mermaidAPI.md +++ b/docs/mermaidAPI.md @@ -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