跳到主要内容

Canary 版本

Docusaurus 提供 Canary 版本。

这允许你在 PR 合并后，就能立刻在 Docusaurus 下一版本前测试最新的未发布功能。

这有助于你向维护者们提交反馈，确保新实现的功能正常工作。

备注

实际上，在生产环境中使用 Canary 版本并不存在风险。

Canary 版本通过了所有的自动化测试，Docusaurus 网站自己也在生产环境中使用此版本。

警告

下面显示的 Canary 版本可能不是最新的。 请前往 npm 页面找到实际版本名称。

Canary npm 版本标签​

每次有新的涉及生产的代码提交到 main 分支上，持续集成 (CI) 都会 在 npm 的 @canary 版本标签下发布一个新版本。 这一般需要 10 分钟左右。

你可以在 npm 上看到当前的版本标签：

  • latest: 稳定版本（当前版本：3.6.1）
  • canary：canary 版本（例如：0.0.0-4922）
提示

检查版本的发布日期并确保用的是最新的 canary 版本，因为有时发布可能会失败。

备注

Canary 版本遵循 0.0.0-commit 编号 的命名规范。

使用 Canary 版本​

以当前 canary 版本标签 下的的最新版本（例如：0.0.0-4922）为例。

把你的 package.json 里的所有 @docusaurus/* 依赖项版本替换成它：

-  "@docusaurus/core": "^3.6.1",
-  "@docusaurus/preset-classic": "^3.6.1",
+  "@docusaurus/core": "0.0.0-4922",
+  "@docusaurus/preset-classic": "0.0.0-4922",

然后重新安装依赖，再启动你的网站：

npm install
npm start

你也可以用命令行更新 @docusaurus* 相关的包：

npm install --save-exact @docusaurus/core@canary @docusaurus/preset-classic@canary
警告

确保升级了所有 @docusaurus/* 包。

建议在安装 Canary 版本时用固定版本号，而不是版本范围（即避免 ^ 前缀）。