公告

— 快使用微信扫码体验一下吧:


Skip to content

简单介绍

VitePress 是一个基于 Vite 和 Vue 3 的静态网站生成器,特别适用于构建文档网站。它提供了快速的开发体验、即时热更新以及优秀的性能。本文将详细介绍如何安装和配置 VitePress,并通过实例代码帮助你快速上手。

准备工作


  • 点击链接 Node.js 进入官网选择下载 V20.18.0(LTS)稳定版,随机选择一个盘(D 盘/E 盘)进行安装。 Node.js安装包自带npm包管理器。
  • 点击链接 git 进入官网选择下载V2.47.0版本,选择一个合适的目录安装即可。
  • 安装包管理器,如 pnpm , yarn , npm ,安装命令如下: 打开命令提示符(cmd),输入此命令即可安装pnpm包管理器:npm insatll -g pnpm,推荐使用pnpm包管理器。
  • 查看当前pnpm版本命令:pnpm -v
  • 查看Node.js版本命令:node -v
  • 以上准备工作全部完成后,即可开始搭建ViePress网站。

快速开始

  1. 在本地存储盘中选择一个合适的位置创建你的项目目录,例如:D:\git\vitepress 本地目录

  2. 在viepress文件目录的地址栏输入cmd命令,回车Enter进入终端命令提示符,如下图所示: 本地目录

  3. 选择如下包管理器命令,在刚刚打开的终端目录下安装vitepress。

js
pnpm add -D vitepress
js
yarn add -D vitepress

安装向导

  1. VitePress 附带一个命令行设置向导,可以帮助你构建一个基本项目。安装后,通过运行以下命令启动向导:
js
pnpm vitepress init
js
yarn vitepress init

将需要回答几个简单的问题: 本地目录

目录结构

如图所示:本地目录

.git忽略项

添加 .gitignore 文件,主要用于上传到gitee/github时,忽略这些文件不上传

js
echo node_modules >> .gitignore
echo cache >> .gitignore
echo dist >> .gitignore

启动运行

  1. 该工具还应该将以下 pnpm 脚本注入到 package.json 中:
js
{
  ...
  "scripts": {
    "docs:dev": "vitepress dev docs",
    "docs:build": "vitepress build docs",
    "docs:preview": "vitepress preview docs"
  },
  ...
}
  1. docs:dev 脚本将启动具有即时热更新的本地开发服务器。使用以下命令运行它:
js
pnpm run docs:dev
js
yarn run docs:dev

构建测试

  1. 可以运行以下命令来构建文档:
js
pnpm run docs:build
  1. 构建文档后,通过运行以下命令可以在本地预览它:
js
pnpm run docs:preview

温馨提示

至此,vitepress创建流程结束,您已经成功创建了自己的个人网站,请尽情撰写个人技术文档吧! 如需解决其他技术配置难题,请自行访问官网VitePress,如需知晓如何将网站部署到github,请看下一章节!