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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

enable auto rerender #4333

Closed
wants to merge 1 commit into from
Closed

Conversation

kaizhang16
Copy link

馃搼 Summary

Enable auto rerender when pnpm run docs:dev. And other projects may also be inspired about how to integrate mermaid into vitepress.

馃搹 Design Decisions

According to https://vuejs.org/guide/essentials/watchers.html, watch track props, and will call renderChar when props changes.

馃搵 Tasks

Make sure you

  • 馃摉 have read the contribution guidelines
  • 馃捇 have added unit/e2e tests (if appropriate)
  • 馃摀 have added documentation (if appropriate)
  • 馃敄 targeted develop branch

@github-actions github-actions bot added the fix label Apr 22, 2023
@sidharthv96
Copy link
Member

Thank you for the PR @kaizhang16, but we already have file watching in docs:dev which re-renders the diagram wh`n the file changes.

Please reopen if you faced a scenario where editing files in packages/mermaid/src/docs didn't change the diagram automatically.

NB: Editing <root>/docs will not change the diagrams, but that is not a problem as packages/mermaid/src/docs is where the editing should be done.

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

Successfully merging this pull request may close these issues.

None yet

2 participants