Skip to content

Commit 12a02e5

Browse files
committed
chore: update docs
1 parent 777d09a commit 12a02e5

File tree

3 files changed

+22
-10
lines changed

3 files changed

+22
-10
lines changed

README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,14 @@ We will start drafting release notes and migration guide for v3.0 when we enter
4646

4747
## Packages
4848

49-
| Package | Version (click for changelogs) |
50-
| --------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
51-
| [vite](packages/vite) | [![vite version](https://img.shields.io/npm/v/vite.svg?label=%20)](packages/vite/CHANGELOG.md) |
52-
| [@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) |
53-
| [@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) |
54-
| [@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) |
55-
| [@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) |
56-
| [@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) |
57-
| [create-vite](packages/create-vite) | [![create-vite version](https://img.shields.io/npm/v/create-vite.svg?label=%20)](packages/create-vite/CHANGELOG.md) |
49+
| Package | Version (click for changelogs) |
50+
| ------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------- |
51+
| [vite](packages/vite) | [![vite version](https://img.shields.io/npm/v/vite.svg?label=%20)](packages/vite/CHANGELOG.md) |
52+
| [@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) |
53+
| [@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) |
54+
| [@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) |
55+
| [@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) |
56+
| [create-vite](packages/create-vite) | [![create-vite version](https://img.shields.io/npm/v/create-vite.svg?label=%20)](packages/create-vite/CHANGELOG.md) |
5857

5958
## Contribution
6059

docs/config/server-options.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Enable TLS + HTTP/2. Note this downgrades to TLS only when the [`server.proxy` o
5555

5656
The value can also be an [options object](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener) passed to `https.createServer()`.
5757

58-
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.
58+
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.
5959

6060
## server.open
6161

docs/guide/migration.md

+13
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,19 @@ You can use `?init` which is similar to the previous behavior.
101101
})
102102
```
103103

104+
### Automatic https certificate generation
105+
106+
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.
107+
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.
108+
109+
```js
110+
import basicSsl from '@vitejs/plugin-basic-ssl'
111+
112+
export default {
113+
plugins: [basicSsl()]
114+
}
115+
```
116+
104117
## Advanced
105118

106119
There are some changes which only affects plugin/tool creators.

0 commit comments

Comments
 (0)