docs: replace VitePress :::key directives with GitHub-style alerts#2336
docs: replace VitePress :::key directives with GitHub-style alerts#2336Aniket-lodh wants to merge 1 commit intowxt-dev:mainfrom
Conversation
✅ Deploy Preview for creative-fairy-df92c4 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
8143611 to
d68b6b3
Compare
|
Just a quick heads up, you can't have text on the same line as the annotation type
That won't render on GitHub, they all need to be split like this: Tip Need to lookup the full import path of an API? |
d68b6b3 to
74879d6
Compare
PatrykKuniczak
left a comment
There was a problem hiding this comment.
Fix also :::code-group and :::details across all files.
And also <<< @/../packages/browser/src/index.mjs#snippet doesn't work let's fix it also there.
Let's use search in IDE and look for ::: then let's fix ALL of that.
And take a look on files before you'll push your changes.
|
|
||
| ::: |
Overview
Replace all VitePress-specific
:::keycontainer directives (:::warning,:::tip,:::info,:::danger,:::details) with GitHub-compatible alternatives across all documentation.mdfiles.Changes:
:::warning→> [!WARNING]:::tip→> [!TIP]:::info→> [!NOTE]:::danger→> [!CAUTION]:::details— converting to HTML<details>breaks VitePress builds because Vue's template compiler parses JSX/HTML inside code fences as real elements.These render correctly on both GitHub's markdown preview and VitePress 1.5+ (GitHub-flavored alerts).
Related Issue
This PR closes #2334