diff --git a/docs/usage.md b/docs/usage.md index 65eecc250..29cc7881c 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -292,9 +292,9 @@ module.exports = (options) -> ## 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 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); ``` -### 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