LinhoNotes

外观

快速开始 ​

前置准备 ​

  • Node.js 18 及以上版本。
  • 通过命令行界面（CLI）访问 VitePress 的终端。

安装依赖：

sh
npm i

TIP

如果身处提瓦特大陆，并且遇到了类似 CONNECTION RESET 或 CONNECTION TIMED OUT 这样的错误，你可能需要确认你的网络情况。可能的解决方法是使用魔法，或更换镜像源。相关内容请自行上网搜索。

启动调试服务器 ​

在终端运行：

sh
npm run dev

如果一切正常，终端将会输出：

  vitepress v1.5.0

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h to show help

此时从浏览器访问 http://localhost:5173/，应能看到本地调试服务器提供的网站。该本地服务器提供即时热更新（Hot Module Replacement, HMR）。

NOTE

部分功能已人为地在调试服务器中禁用。包括：

  • 文章最后更新时间显示
  • 文章贡献者显示

禁用这些功能的原因是，部分设备有时没有正确配置命令行 Git，而这些功能依赖 Git。

构建 ​

在终端运行：

sh
npm run build

将执行网站构建。构建完成后，执行

sh
npm run preview

可以启动一个本地预览服务器，默认运行在 http://localhost:4173/。

TIP

你可能会在构建时遇到如下错误：

txt
Avatar download failed

这是贡献者列表头像镜像产生的报错，也由网络状况引起。该报错在 GitHub Actions 上执行构建时不会产生。

另外，如果遇到 GitHub 请求超出限额的情况（无 Token 时最高每小时 60 次请求），你需要在 GitHub 上申请一个 Token，并在项目根目录下新建一个名为 .env 的文件，内容为：

ini
GITHUB_TOKEN=(你的 Token)

或者你也可以直接在 .env 中写下

ini
DISABLE_CONTRIBUTORS=1

来在本地禁用贡献者列表功能。.env 在 .gitignore 中，因此更改不会上传到远端。