You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Problem is I am not able to load that graph's markdown so that it can be rendered in TypeDoc.
An entire community of users growing around StencilJS can benefit from this feature.
Describe the solution you'd like
Currently, this plugin allows:
/**
* Hoge is sample class for example of `typedoc-plugin-mermaid`.
*
* @mermaid Make TypeDoc easy to use with mermaid.js
* graph TB
* mermaid.js --> TypeDoc;
*/
export class Hoge { }
It will be great if a relative/path/to/graph can also be supported as alternate to inline graph.
/**
* Hoge is sample class for example of `typedoc-plugin-mermaid`.
*
* @mermaid Make TypeDoc easy to use with mermaid.js
* mermaid-path: relative/path/to/graph
*/
export class Hoge { }
The plugin loads the markdown file, extracts the mermaid graph and renders it as usual.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
README.md
adjacent to theclass.ts[x]
file.Describe the solution you'd like
relative/path/to/graph
can also be supported as alternate to inline graph.The text was updated successfully, but these errors were encountered: