Skip to content

Commit 4ecde7a

Browse files
authored
chore(vue): Fix markdown file usage syntax
1 parent b7b6b6f commit 4ecde7a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

packages/vue/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,14 @@ import {
7676

7777
### Usage inside Markdown files
7878

79-
If you're using a static site generator like [VuePress](https://vuepress.vuejs.org/) and want to use these components inside your Markdown files, you should use it as such:
79+
If you're using a static site generator like [VuePress 2](https://v2.vuepress.vuejs.org/) and want to use these components inside your Markdown files, you should use them with PascalCase names:
8080

8181
```html
82-
<div is="discord-messages">
83-
<discord-message>
82+
<DiscordMessages>
83+
<DiscordMessage>
8484
...
85-
</discord-message>
86-
</div>
85+
</DiscordMessage>
86+
</DiscordMessages>
8787
```
8888

8989
This is the recommended approach due to how VuePress renders Markdown and HTML inside Markdown files. It doesn't recognize `<discord-messages>` as an HTML element, therefore rendering anything indented inside it as a regular codeblock.

0 commit comments

Comments
 (0)