Skip to content

网站搭建与部署指南

这一页是本项目的操作检查清单。以后忘了怎么更新网站,就回来看这里。

  • 已使用 Astro + Starlight 搭好文档站。
  • 已配置站点标题、描述、GitHub 链接和侧边栏。
  • 已创建 src/assets/images/,后续截图、GIF、配图都放这里。
  • 已采用 MIT License,内容和示例代码都尽量保持轻量开放。
  • 已保留 design/book-plan-warm.md 作为写作规划源文件。

在项目根目录运行:

Terminal window
npm run dev

打开终端提示里的地址,通常是:

http://localhost:4321

所有正式网页文章都放在:

src/content/docs/

建议按章节建目录,例如:

src/content/docs/01-getting-started/01-curiosity.md

图片、截图和 GIF 放在:

src/assets/images/

新增章节后,打开 astro.config.mjs,在 sidebar 里增加对应链接。

例如:

{ label: '2. AI 是你的创作搭档', link: '/01-getting-started/02-ai-partner/' }
Terminal window
git add .
git commit -m "docs: 新增章节内容"
git push

推送后,Cloudflare Pages 会自动重新构建并更新网站。

进入 Cloudflare Pages 后选择连接 Git 仓库,核心设置如下:

项目填写
Framework presetAstro
Build commandnpm run build
Build output directorydist
Root directory留空,使用仓库根目录
Production branchmain

部署成功后,站点地址预计是:

https://vrchat-world-tutorial.pages.dev

仓库 About 区域建议填写:

VRChat 世界开发中文教程。The complete guide and tutorial for VRChat world creation, Unity setup, and UdonSharp programming.

Topics 建议添加:

vrchat
vrchat-world
vrchat-tutorial
udon
udonsharp
unity
guide
book

可以在仓库 Settings 里开启 Discussions,后续用来收集读者问题。

  • 不要把 node_modules/dist/ 提交到仓库。
  • 不要把大于 25MB 的超大 GIF、UnityPackage 或素材包直接塞进仓库。
  • 大资源建议放到 GitHub Releases,再在文章里贴下载链接。
  • 技术章节写完后,尽量标注使用的 Unity、VRChat SDK、UdonSharp 版本。