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

Update usage.md

Browse Source
This commit is contained in:
Neil Cuzon
2021-09-17 19:00:51 -07:00
committed by GitHub
parent 866ee997d9
commit 5f27987ca2
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/usage.md
View File

@@ -292,9 +292,9 @@ module.exports = (options) ->
## Advanced usage ## Advanced usage
**Syntax validation (Work in Progress)** **Syntax validation without rendering (Work in Progress)**
Ideally, **mermaid.parse(txt)** function validates graph definitions without rendering a graph. **(This function is still a work in progress, find alternatives below)** The **mermaid.parse(txt)** function validates graph definitions without rendering a graph. **[This function is still a work in progress](https://github.com/mermaid-js/mermaid/issues/1066), find alternatives below**
The function **mermaid.parse(txt)**, takes a text string as an argument and returns true if the definition follows mermaid's syntax and The function **mermaid.parse(txt)**, takes a text string as an argument and returns true if the definition follows mermaid's syntax and
false if it does not. The parseError function will be called when the parse function returns false. false if it does not. The parseError function will be called when the parse function returns false.
@@ -319,7 +319,9 @@ var textFieldUpdated = function(){
bindEventHandler('change', 'code', textFieldUpdated); bindEventHandler('change', 'code', textFieldUpdated);
``` ```
### Alternative to mermaid.parse() **Alternative to mermaid.parse()**
One effective and more future-proof method of validating your graph deinitions, is to paste and render them via the [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor/). This will ensure that your code is compliant with the syntax of Mermaid's most recent version.
## Configuration ## Configuration