six-webcomponents icon indicating copy to clipboard operation
six-webcomponents copied to clipboard

fix: #151 mermaid diagrams not rendered correctly

Open colinscz opened this issue 6 months ago โ€ข 0 comments

๐Ÿ”— Linked issue

Closes #151

โ“ Type of change

  • [x] ๐Ÿ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • [x] ๐Ÿž Bug fix (a non-breaking change that fixes an issue)
  • [ ] ๐Ÿ‘Œ Enhancement (improving an existing functionality like performance)
  • [ ] โœจ New feature (a non-breaking change that adds functionality)
  • [ ] ๐Ÿงน Chore (updates to the build process or auxiliary tools and libraries)
  • [ ] โš ๏ธ Breaking change (fix or feature that would cause existing functionality to change)

๐Ÿ“š Description

Solves the display issue with the mermaid plugin. Solution inspired by the workaround explained here: https://advanced-stack.com/resources/how-to-setup-vitepress-mermaid-plugin.html

grafik

Partially this works, but diagrams for some of the components are not yet rendered properly.

๐Ÿ“ Checklist

  • [x] I have linked an issue or discussion.
  • [x] It's submitted to the main branch
  • [x] When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)
  • [x] I have updated the documentation accordingly.
  • [ ] All tests are passing
  • [ ] New/updated tests are included
  • [ ] I have updated the "upcoming" section inside docs/changelog.md explaining the changes I contributed

If adding a new feature, the PR's description includes:

  • [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

Other information:

colinscz avatar Aug 14 '24 08:08 colinscz