开始
Vite 意在提供开箱即用的配置,同时它的 和 JavaScript API 带来了高度的可扩展性,并有完整的类型支持。
你可以在 中了解更多关于项目的设计初衷。
浏览器支持
::: tip 兼容性注意 Vite 需要 版本 >= 12.0.0。 :::
使用 NPM:
使用 Yarn:
$ yarn create @vitejs/app
你还可以通过附加的命令行选项直接指定项目名称和你想要使用的模板。例如,要构建一个 Vite + Vue 项目,运行:
支持的模板预设包括:
vanilla
vanilla-ts
vue
vue-ts
react
react-ts
preact
preact-ts
lit-element
lit-element-ts
svelte-ts
查看 @vitejs/create-app 获取每个模板的更多细节。
社区模板
@vitejs/create-app 是一个快速生成主流框架基础模板的工具。查看 Awesome Vite 仓库的 社区维护模板,里面包含各种工具和不同框架的模板。你可以用如 之类的工具,使用社区模版来搭建项目。
npx degit user/project my-project
npm install
npm run dev
如果该项目使用 main
作为默认分支, 需要在项目名后添加 #main
。
你可能已经注意到,在一个 Vite 项目中,index.html
在项目最外层而不是在 public
文件夹内。这是有意而为之的:在开发期间 Vite 是一个服务器,而 index.html
是该 Vite 项目的入口文件。
Vite 将 index.html
视为源码和模块图的一部分。Vite 解析 <script type="module" src="...">
,这个标签指向你的 JavaScript 源码。甚至内联引入 JavaScript 的 <script type="module">
和引用 CSS 的 <link href>
也能利用 Vite 特有的功能被解析。另外,index.html
中的 URL 将被自动转换,因此不再需要 %PUBLIC_URL%
占位符了。
Vite 也支持多个 .html
作入口点的 多页面应用模式。
指定替代根目录
vite
以当前工作目录作为根目录启动开发服务器。你也可以通过 vite serve some/sub/dir
来指定一个替代的根目录。
命令行界面
在安装了 Vite 的项目中,可以在 npm scripts 中使用 vite
可执行文件,或者直接使用 npx vite
运行它。下面是通过脚手架创建的 Vite 项目中默认的 npm scripts:
{
"scripts": {
"dev": "vite", // 启动开发服务器
"build": "vite build", // 为生产环境构建产物
"serve": "vite preview" // 本地预览生产构建产物
}
可以指定额外的命令行选项,如 --port
或 --https
。运行 npx vite --help
获得完整的命令行选项列表。
如果你迫不及待想要体验最新的功能,可以自行克隆 到本地机器上然后自行将其链接(将需要 Yarn 1.x):
然后,回到你的 vite 项目并运行 。重新启动开发服务器(yarn dev
)来体验新功能吧!
社区
如果你有疑问或者需要帮助,可以到 Discord 和 社区来寻求帮助。