Skip to content

Commit 64aa8e2

Browse files
committed
docs: add note on compiler-sfc/server-renderer usage update [ci skip]
1 parent b9deb6e commit 64aa8e2

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

packages/compiler-sfc/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22

33
> Lower level utilities for compiling Vue Single File Components
44
5+
**Note: as of 3.2.13+, this package is included as a dependency of the main `vue` package and can be accessed as `vue/compiler-sfc`. This means you no longer need to explicitly install this package and ensure its version match that of `vue`'s. Just use the main `vue/compiler-sfc` deep import instead.**
6+
57
This package contains lower level utilities that you can use if you are writing a plugin / transform for a bundler or module system that compiles Vue Single File Components (SFCs) into JavaScript. It is used in [vue-loader](https://github.com/vuejs/vue-loader), [rollup-plugin-vue](https://github.com/vuejs/rollup-plugin-vue) and [vite](https://github.com/vitejs/vite).
68

79
## API
810

911
The API is intentionally low-level due to the various considerations when integrating Vue SFCs in a build system:
1012

1113
- Separate hot-module replacement (HMR) for script, template and styles
14+
1215
- template updates should not reset component state
1316
- style updates should be performed without component re-render
1417

@@ -74,6 +77,4 @@ export default script
7477

7578
Options needed for these APIs can be passed via the query string.
7679

77-
78-
7980
For detailed API references and options, check out the source type definitions. For actual usage of these APIs, check out [rollup-plugin-vue](https://github.com/vuejs/rollup-plugin-vue/tree/next) or [vue-loader](https://github.com/vuejs/vue-loader/tree/next).

packages/server-renderer/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @vue/server-renderer
22

3+
**Note: as of 3.2.13+, this package is included as a dependency of the main `vue` package and can be accessed as `vue/server-renderer`. This means you no longer need to explicitly install this package and ensure its version match that of `vue`'s. Just use the `vue/server-renderer` deep import instead.**
4+
35
## Basic API
46

57
### `renderToString`

0 commit comments

Comments
 (0)