From 64aa8e26ae6c5db927b18bde01fbe0eb4ef460aa Mon Sep 17 00:00:00 2001 From: Evan You Date: Tue, 21 Sep 2021 22:55:10 -0400 Subject: [PATCH] docs: add note on compiler-sfc/server-renderer usage update [ci skip] --- packages/compiler-sfc/README.md | 5 +++-- packages/server-renderer/README.md | 2 ++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/packages/compiler-sfc/README.md b/packages/compiler-sfc/README.md index 1d6d8db4..c76618e4 100644 --- a/packages/compiler-sfc/README.md +++ b/packages/compiler-sfc/README.md @@ -2,6 +2,8 @@ > Lower level utilities for compiling Vue Single File Components +**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.** + 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). ## API @@ -9,6 +11,7 @@ This package contains lower level utilities that you can use if you are writing The API is intentionally low-level due to the various considerations when integrating Vue SFCs in a build system: - Separate hot-module replacement (HMR) for script, template and styles + - template updates should not reset component state - style updates should be performed without component re-render @@ -74,6 +77,4 @@ export default script Options needed for these APIs can be passed via the query string. - - 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). diff --git a/packages/server-renderer/README.md b/packages/server-renderer/README.md index 7cec9a6f..4188fc93 100644 --- a/packages/server-renderer/README.md +++ b/packages/server-renderer/README.md @@ -1,5 +1,7 @@ # @vue/server-renderer +**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.** + ## Basic API ### `renderToString`