Skip to content

部署说明 ​

本站是纯静态站点,构建产物在 docs/.vitepress/dist,可以直接托管在 Cloudflare Pages 上(免费、国内访问相对稳定)。

一、本地构建验证 ​

bash
pnpm install
pnpm build

构建成功后产物在 docs/.vitepress/dist。可以先本地预览:

bash
pnpm preview

二、推送到 GitHub ​

bash
git init
git add .
git commit -m "init: 南林 Wiki 骨架"
git branch -M main
git remote add origin https://github.com/<你的用户名>/njfu-wiki.git
git push -u origin main

三、连接 Cloudflare Pages ​

  1. 登录 Cloudflare Dashboard,进入 Workers & Pages → Create → Pages → Connect to Git。
  2. 授权 GitHub,选择 njfu-wiki 仓库。
  3. 填写构建设置:
配置项值
Framework presetVitePress
Build commandpnpm build 或 npm run build
Build output directorydocs/.vitepress/dist
Root directory(留空)
  1. 环境变量(如果构建时提示 Node 版本过低):
变量名值
NODE_VERSION22
PNPM_VERSION9
  1. 点击 Save and Deploy。首次构建约 1-3 分钟,完成后会得到一个 xxx.pages.dev 的域名。

之后每次 git push 到 main,Cloudflare 会自动重新构建并发布。

四、绑定自定义域名(可选) ​

  1. 在 Pages 项目的 Custom domains 里添加你的域名。
  2. 如果域名托管在 Cloudflare,会自动配置 DNS;否则在你的域名商处添加 CNAME 记录指向 xxx.pages.dev。

五、注意事项 ​

  • SPA 回退:VitePress 生成的是静态 HTML,一般无需额外配置。若出现 404,在 Pages 设置里确认没有开启 SPA fallback。
  • cleanUrls:本站配置了 cleanUrls: true,访问路径不带 .html。Cloudflare Pages 原生支持。
  • 构建失败排查:本地先跑 pnpm build,本地能过线上一般也能过。
  • 搜索功能:本站使用 VitePress 内置的本地搜索(provider: 'local'),构建时会生成索引,无需第三方服务。

六、其他托管选择 ​

平台说明
Cloudflare Pages推荐,免费额度充足
Vercel配置简单,国内访问一般
GitHub Pages需要额外配置 base 路径
Netlify类似 Cloudflare Pages

公益项目,与任何组织无关。