VitePress 是一个静态站点生成器 (SSG),专为构建快速、以内容为中心的站点而设计。简而言之,VitePress 获取用 Markdown 编写的内容,对其应用主题,并生成可以轻松部署到任何地方的静态 HTML 页面。
与 VuePress 的区别
| 特性 | VuePress v1 | VitePress |
|---|---|---|
| 底层打包工具 | Webpack | Vite |
| 开发服务器性能 | 较慢 | 极快 |
| 配置 | 较为复杂 | 更简洁 |
| 生态 | 成熟,插件丰富 | 正在快速发展 |
如果你正在开始一个新项目,可以考虑使用 VitePress,它因其卓越的开发体验和性能而成为首选。
适用场景
VitePress 非常适合用于构建:
- 技术文档
- 个人博客
- 产品介绍网站
- 开源项目主页
快速上手
VitePress 的使用非常简单,按以下步骤即可快速上手。
- 通过以下命令快速创建一个 VitePress 项目:
bash
npm add -D vitepress
npx vitepress init然后按照命令行提示进行操作,即可启动你的文档网站。
- 创建一个 Markdown 文件,例如
docs/index.md(一般情况下上述命令已生成),并在其中编写你的内容。 - 在
.vitepress/config.mts文件中配置网站的基本信息,例如网站标题、描述和 logo。 - 通过
npm run docs:dev启动开发服务器。 - 在浏览器中访问
http://localhost:5173,VitePress 将实时地预览你的网站。
另外,当你准备好部署网站时,可以运行以下命令:
bash
npm run docs:build这会在 .vitepress/dist 目录下生成最终的静态文件,你可以将这个目录下的所有内容部署到任何静态托管服务上。