Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What are current limitations of this package right now? #9

Open
malikalimoekhamedov opened this issue Jun 14, 2021 · 1 comment
Open

Comments

@malikalimoekhamedov
Copy link

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
    }
  }
}
@FilipaChambel
Copy link

At the moment, I am only able to generate graphs with the "graph TD", not any other type of graph (gitgraph, flowchart, user journey, etc). any solutions for this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants