jellyvision/jsdoc-mermaid

A tool to automagically create flowcharts and diagrams in your jsdocs.

jsdoc-mermaid's Issues

What are current limitations of this package right now?

I've looked at the implementation of this packages and it looks like all of current Mermaid syntax should be supported, yet, if I generate documentation using things like {{}} or ([])or [*] for flow diagrams, no diagram will be generated or the branch of the graph that uses these conventions will be missing.
If I try using the sequenceDiagram-v2, I get nothing either.
Nothing is mentioned about current limitations of the package so I was expecting all of Mermaid notation to work but... it doesn't.

If that's any help, I'm using jsdoc in combination with better-docs together with their template. Here's what my jsdoc.json looks like:

{
  "source": {
    "include": ["src"],
    "includePattern": "\\.ts$",
    "excludePattern": "(node_modules/|docs)"
  },
  "opts": {
    "readme": "README.md",
    "recurse": true,
    "destination": "docs/",
    "template": "node_modules/better-docs",
    "verbose": true
  },
  "tags": {
    "allowUnknownTags": true
  },
  "plugins": [
    "plugins/markdown",
    "node_modules/better-docs/typescript",
    "node_modules/better-docs/category",
    "jsdoc-mermaid"
  ],
  "templates": {
    "search": true,
    "better-docs": {
      "name": "...name of my project",
      "hideGenerator": true
    }
  }
}

Update NPM package

Hi,

It seems that your npm package is way outdated (3 years ago).
Could you update it with your latest gitHub version?

Thanks!

Mermaid in README.md

Cool plugin! I'm using it extensively.
Would be nice if it would also render mermaid charts from the README.md on the "Home" page of the documentation.

using 'par' (parellel events) in sequence diagram

 *     par [Action 1]
 *         Host->>Client: information
 *     and [Action 2]
 *         Host->>Client2: same information
 *     end

Fails to render in jsdoc for a sequence diagram.

jsdoc-mermaid package version ^1.0.0
jsdoc version ^3.6.6

mermaid version outdated

Mermaid is at version 7.1.2 - can we update this?