跳到主要内容

vitepress构建

环境准备
  • Node.js 18.x 或更高版本
  • Git 版本控制工具
  • GitHub 账号

完整部署流程​

1. 创建 GitHub 仓库​

  1. 登录 GitHub
  2. 点击右上角 ➕ 选择 "New repository"
  3. 输入仓库名称 mydoc（建议使用全小写）
  4. 勾选 "Initialize this repository with a README"
  5. 复制仓库 SSH 地址备用： 
    [email protected]:[你的用户名]/mydoc.git

2. 初始化本地项目​

# 创建项目目录
mkdir mydoc && cd mydoc

# 初始化 Node.js 项目（自动生成 package.json）
npm init -y

# 安装 VitePress 开发依赖
npm install -D vitepress

# 初始化 VitePress 配置（按需选择配置项）
npx vitepress init

3. 项目配置与构建​

# 生产环境构建（生成静态文件到 .vitepress/dist）
npm run docs:build

4. 自动化部署配置​

# 初始化 Git 仓库
git init

# 添加远程仓库
git remote add origin [email protected]:[你的用户名]/mydoc.git

提交构建产物（每次更新后执行）

npm run docs:build
git add .vitepress/dist -f
git commit -m "更新文档内容"
git subtree push --prefix .vitepress/dist origin main

注意事项​

  1. 确保 SSH 密钥已添加到 GitHub 账号
  2. 首次部署可能需要 5-10 分钟生效
  3. 建议在 docs/.vitepress/config.js 中配置站点元信息
  4. 使用 Markdown 文件组织文档内容（默认位置：/docs 目录）