Skip to content

doc(fix vuejs/core#11367):add a warn about '~' in src-imports #3061

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Oct 18, 2024
Merged

doc(fix vuejs/core#11367):add a warn about '~' in src-imports #3061

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
626127f
doc:add a warn about '~' in src-imports
Oct 12, 2024
cb80c35
Update src/api/sfc-spec.md
Bayn-Web Oct 14, 2024
05547f6
Update src/api/sfc-spec.md
Bayn-Web Oct 16, 2024
64386ff
doc(import statement): add import statement in script setup
Bayn-Web Oct 18, 2024
6ac2586
doc(import statement): delete extraneous blank lines
Bayn-Web Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/api/sfc-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,13 @@ Beware that `src` imports follow the same path resolution rules as webpack modul
</unit-test>
```

:::warning Note
While using aliases in `src`,don't start with `~`(It can be used in `import` seq ), anything after it is interpreted as a module request. This means you can reference assets inside node modules:
```vue
<img src="~some-npm-package/foo.png">
```
:::

## Comments {#comments}

Inside each block you shall use the comment syntax of the language being used (HTML, CSS, JavaScript, Pug, etc.). For top-level comments, use HTML comment syntax: `<!-- comment contents here -->`