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

Fetch mermaid graph markdown from README.md #184

Open
maneetgoyal opened this issue May 10, 2020 · 5 comments
Open

Fetch mermaid graph markdown from README.md #184

maneetgoyal opened this issue May 10, 2020 · 5 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@maneetgoyal
Copy link

Is your feature request related to a problem? Please describe.

  1. Want to render a Mermaid graph before each class (this plugin already does that).
  2. But the Mermaid graph's markdown is stored in a README.md adjacent to the class.ts[x] file.
  3. Here's an example.
  4. Problem is I am not able to load that graph's markdown so that it can be rendered in TypeDoc.
  5. An entire community of users growing around StencilJS can benefit from this feature.

Describe the solution you'd like

  1. 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 { }
  1. 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 { }
  1. The plugin loads the markdown file, extracts the mermaid graph and renders it as usual.
@kamiazya kamiazya added help wanted Extra attention is needed enhancement New feature or request labels Nov 25, 2020
@kamiazya
Copy link
Owner

@maneetgoyal Thanks for reporting!

I fixed it in #630.

@kamiazya
Copy link
Owner

@all-contributors please add @maneetgoyal for bug.

@allcontributors
Copy link
Contributor

@kamiazya

I've put up a pull request to add @maneetgoyal! 🎉

@kamiazya
Copy link
Owner

Sorry, I used the wrong issue to comment on.

I will reopen it.

@kamiazya kamiazya reopened this Jul 16, 2022
@hatless
Copy link

hatless commented Jan 11, 2024

I'd like to see this include Mermaid code blocks in the rendering of the README.md itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants