预览你的网站

当你想要对网站进行修改时，你可能需要一个便捷的方式来预览和检查这些更改，然后再发布它们。

就像编辑你的网站一样，预览网站有两种方式：在 GitHub 上和在你的电脑上。

在 GitHub 上（远程）

当你在 GitHub 上打开或更新一个 pull request 时，模板会为你正在进行的更改构建一个实时预览。预览的公共链接会出现在 pull request 的评论中。这样，审阅者和编辑者就可以方便地看到更改的具体效果。

TIP

注意：pull request 上的评论会在预览实际完成部署之前稍早出现（约 30 秒）。如果你点击链接看到 404 错误或未更新的网站，请记住这一点。

模板还会告诉 GitHub 自动运行引用处理并提交生成的引用。这会在你推送到 main 分支或创建 pull request 时发生。

如果你正在从 fork 创建 pull request，请确保在 pull request 中勾选了"允许维护者编辑"选项（在打开之前），这样引用处理才有权限提交其结果。

WARNING

由于GitHub 的限制，如果你从组织下的 fork 进行更改，你将看不到"允许编辑"选项，引用处理也无法工作。你需要改用分支进行更改，或在本地运行引用处理。

在你的电脑上（本地）

1. 安装 Docker Desktop（推荐）或仅安装 Docker 并启动它。
2. 运行 ./.docker/run.sh。
3. 等待 Docker 构建一个包含模板所需的所有语言和包的沙箱。首次运行大约需要 2 分钟，之后的运行几乎是即时的。
4. 等待 Docker 启动预览。你很快就会得到一个 localhost 链接，可以在浏览器中打开它来查看你的网站预览。
5. 当你对仓库文件夹中的文件进行更改时，预览应该会自动刷新/更新，除了对 _config.yaml 的更改需要手动刷新。
6. 当你对源文件或元源文件进行更改时，引用处理会自动重新运行，完成后会通过上述相同的行为反映在你的预览中。

非 Docker 说明

我们推荐使用 Docker 进行本地预览有以下几个原因：

• 你只需要安装一个东西
• 你只需要记住并运行一个命令就可以完成网站构建和引用处理
• 所有内容都能在任何操作系统上正确安装和一致运行，这是 Jekyll/Node.js 的优势

如果你觉得 Docker 方式太重，而且你的系统可以可靠地运行 Node.js，你可以使用手动的低级方式在本地预览你的网站：

构建网站：

1. 安装 Node.js v16+ 和 npm。
2. 运行 npm install 安装依赖。
3. 运行 npm run docs:dev 启动开发服务器。
4. 当你对 .vitepress/config.ts 进行更改时，需要重新运行上述命令。

运行引用处理：

1. 安装 Python 3（带 PIP）。
2. 运行 python -m pip install --upgrade --requirement ./_cite/requirements.txt 安装所需的 Python 包。
3. 运行 python ./_cite/cite.py 生成引用。
4. 当你对输入源和元源进行更改时，需要重新运行上述命令。