diff --git a/README.md b/README.md index 9ac9009..2a87926 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ [![npm version](https://badge.fury.io/js/docsify-mermaid.svg)](https://www.npmjs.com/package/docsify-mermaid) -mermaid-docsify is a docsify plugin which allows to render mermaid diagrams in docsify. +mermaid-docsify is a docsify plugin which allows to render mermaid diagrams in docsify. Supports both mermaid v9 and v10+. ## How to use -Add Mermaid and the plugin: +Add Mermaid and the plugin. Choose the option matching your mermaid version: + +### Mermaid v10+ (ESM) ```html ``` -You can optionally customize [mermaid.run](https://mermaid.js.org/config/usage.html#using-mermaid-run) configuration with this props : +### Mermaid v9 (regular script) + +```html + + + +``` + +You can optionally customize [mermaid.run](https://mermaid.js.org/config/usage.html#using-mermaid-run) (v10+) or [mermaid.init](https://mermaid.js.org/config/usage.html) (v9) configuration with this props: ```html