准备工作
- Node.JS版本18或更高版本 https://nodejs.org/en
- 具有Markdown语法支持的文本编辑器
- git https://git-scm.com/
初始化项目
- 创建文件夹并进入到项目的目录中,打开cmd cd到该目录下
mkdir vitepress-starter && cd vitepress-starter
- 初始化项目,官网默认使用yarn作为依赖管理工具
yarn init
- 安装项目所需的依赖vitepress和vue
yarn add --dev vitepress vue
- 创建第一个实例文件
mkdir docs && echo '# My name is Zhuang Niuniu' > docs/index.md
- 在
package.json
中增加打包以及运行的指令
"scripts": {
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:serve": "vitepress serve docs"
},
- 执行
npm run docs:dev
,项目运行本地生成一个链接,点击能够访问看见你刚刚在index.md
写的内容(例如:My name is Zhuang Niuniu)则代表运行成功