update docs to reference mermaidConfig correctly

[antingle]

I had trouble configuring the Mermaid configuration options for this plugin because mermaidOptions was actually renamed to mermaidConfig. I only realized this when I checked the type annotations on the options object for the plugin. I have updated the docs to correctly reference the name of it, as well as update the link to the Mermaid config schema

[remcohaszing]

Thanks! CI is failing, but I don’t see how that’s related to your changes, so I’ll look into it.

You should probably use rehype-mermaid instead of this project though.

[antingle]

OK thank you. Why should I use rehype-mermaidjs? I just have a simple use case of displaying Mermaid diagrams on markdown files and this plugin does the job. My previous plugins are also remark. I believe if I want to use rehype-mermaidjs, I also need to install rehype-remark, so that is an additional package.

[wooorm]

Depends on your use case indeed.
If you in anyway care about HTML, it’s highly likely you need rehype, and remark-rehype (not the inverse, rehype-remark).
More info here: https://github.com/rehypejs/rehype-remark#what-is-this.
I’d need to know what you’re doing to properly answer what you need

[remcohaszing]

Typically people render markdown to HTML (or MDX to JS). If this is the case, you should use rehype-mermaid. If your goal is to replace mermaid code blocks in markdown files with SVG elements and then emit this as markdown, you should use remark-mermaidjs. This is not a common use case though.

The only reason this project isn’t deprecated, is because it is still used by gatsby-remark-mermaid.