chore: update docs

vitejs · Jul 7, 2022 · 12a02e5 · 12a02e5
1 parent 777d09a
commit 12a02e5
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -46,15 +46,14 @@ We will start drafting release notes and migration guide for v3.0 when we enter
 
 ## Packages
 
-| Package                                                                     | Version (click for changelogs)                                                                                                                                |
-| --------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| [vite](packages/vite)                                                       | [![vite version](https://img.shields.io/npm/v/vite.svg?label=%20)](packages/vite/CHANGELOG.md)                                                                |
-| [@vitejs/plugin-vue](packages/plugin-vue)                                   | [![plugin-vue version](https://img.shields.io/npm/v/@vitejs/plugin-vue.svg?label=%20)](packages/plugin-vue/CHANGELOG.md)                                      |
-| [@vitejs/plugin-vue-jsx](packages/plugin-vue-jsx)                           | [![plugin-vue-jsx version](https://img.shields.io/npm/v/@vitejs/plugin-vue-jsx.svg?label=%20)](packages/plugin-vue-jsx/CHANGELOG.md)                          |
-| [@vitejs/plugin-react](packages/plugin-react)                               | [![plugin-react version](https://img.shields.io/npm/v/@vitejs/plugin-react.svg?label=%20)](packages/plugin-react/CHANGELOG.md)                                |
-| [@vitejs/plugin-legacy](packages/plugin-legacy)                             | [![plugin-legacy version](https://img.shields.io/npm/v/@vitejs/plugin-legacy.svg?label=%20)](packages/plugin-legacy/CHANGELOG.md)                             |
-| [@vitejs/plugin-basic-ssl](https://github.com/vitejs/vite-plugin-basic-ssl) | [![plugin-legacy version](https://img.shields.io/npm/v/@vitejs/plugin-basic-ssl.svg?label=%20)](https://github.com/vitejs/vite-plugin-basic-ssl/CHANGELOG.md) |
-| [create-vite](packages/create-vite)                                         | [![create-vite version](https://img.shields.io/npm/v/create-vite.svg?label=%20)](packages/create-vite/CHANGELOG.md)                                           |
+| Package                                           | Version (click for changelogs)                                                                                                       |
+| ------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------- |
+| [vite](packages/vite)                             | [![vite version](https://img.shields.io/npm/v/vite.svg?label=%20)](packages/vite/CHANGELOG.md)                                       |
+| [@vitejs/plugin-vue](packages/plugin-vue)         | [![plugin-vue version](https://img.shields.io/npm/v/@vitejs/plugin-vue.svg?label=%20)](packages/plugin-vue/CHANGELOG.md)             |
+| [@vitejs/plugin-vue-jsx](packages/plugin-vue-jsx) | [![plugin-vue-jsx version](https://img.shields.io/npm/v/@vitejs/plugin-vue-jsx.svg?label=%20)](packages/plugin-vue-jsx/CHANGELOG.md) |
+| [@vitejs/plugin-react](packages/plugin-react)     | [![plugin-react version](https://img.shields.io/npm/v/@vitejs/plugin-react.svg?label=%20)](packages/plugin-react/CHANGELOG.md)       |
+| [@vitejs/plugin-legacy](packages/plugin-legacy)   | [![plugin-legacy version](https://img.shields.io/npm/v/@vitejs/plugin-legacy.svg?label=%20)](packages/plugin-legacy/CHANGELOG.md)    |
+| [create-vite](packages/create-vite)               | [![create-vite version](https://img.shields.io/npm/v/create-vite.svg?label=%20)](packages/create-vite/CHANGELOG.md)                  |
 
 ## Contribution
 

diff --git a/docs/config/server-options.md b/docs/config/server-options.md
@@ -55,7 +55,7 @@ Enable TLS + HTTP/2. Note this downgrades to TLS only when the [`server.proxy` o
 
 The value can also be an [options object](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener) passed to `https.createServer()`.
 
-A valid certificate is needed. For a basic setup, you can add [@vitejs/plugin-basic-ssl](https://github.com/vitejs/vite-plugin-basic-ssl) to the project plugins, which will automatically create and cache a self-signed certificate.
+A valid certificate is needed. For a basic setup, you can add [@vitejs/plugin-basic-ssl](https://github.com/vitejs/vite-plugin-basic-ssl) to the project plugins, which will automatically create and cache a self-signed certificate. But we recommend creating your own certificates.
 
 ## server.open
 

diff --git a/docs/guide/migration.md b/docs/guide/migration.md
@@ -101,6 +101,19 @@ You can use `?init` which is similar to the previous behavior.
 })
 ```
 
+### Automatic https certificate generation
+
+A valid certificate is needed when using `https`. In Vite v2, if no certificate was configured, a self-signed certificate was automatically created and cached.
+Since Vite v3, we recommend manually creating your certificates. If you still want to use the automatic generation from v2, this feature can be enabled back by adding [@vitejs/plugin-basic-ssl](https://github.com/vitejs/vite-plugin-basic-ssl) to the project plugins.
+
+```js
+import basicSsl from '@vitejs/plugin-basic-ssl'
+
+export default {
+  plugins: [basicSsl()]
+}
+```
+
 ## Advanced
 
 There are some changes which only affects plugin/tool creators.