跳到主要内容

Docusaurus 2.4

·4分钟阅读
Sébastien Lorber
Sébastien Lorber
Docusaurus 维护者，《本周 React》编辑

我们很高兴地宣布 Docusaurus 2.4。

升级应该很容易：正如我们在发布流程文档中解释的，次要版本遵循语义化版本控制。

Docusaurus blog post social card

亮点​

在 #8236 中，我们现在可以为类型为 link 和 category 的文档侧边栏项提供新的 description 属性。

sidebars.js
[
  {
    type: 'link',
    label: 'Link with description',
    href: 'https://docusaurus.org.cn',
    description: 'Some link description',
  },
  {
    type: 'category',
    label: 'Category with description',
    description: 'Some category description',
    items: [],
  },
];

这些描述将用于分类生成的索引页面。

Show sidebar category generated index with custom descriptions

主题查询字符串​

在 #8708 中，我们增加了通过新的 docusaurus-theme 查询字符串参数强制 Docusaurus 以 light 或 dark 模式初始化自身的功能。

这有助于在将现有 Docusaurus 页面嵌入 iframe 或 WebView 时确保主题一致。

/docs/?docusaurus-theme=light
/docs/?docusaurus-theme=dark

Remark 插件 npm2yarn 升级​

在 #8690 中，我们升级了 Remark 插件 @docusaurus/remark-plugin-npm2yarn，修复了许多转换错误，增加了对 pnpm 的一流支持，并能够注册生成新选项卡的自定义转换器。

Run these commands!

```bash npm2yarn
npm install
npm run build
npm run myCustomScript -- --some-arg
```
https://:3000
npm install
npm run build
npm run myCustomScript -- --some-arg

gtag 支持多个跟踪 ID​

在 #8620 中，我们为 @docusaurus/plugin-google-gtag 插件添加了声明多个跟踪 ID 的支持。

docusaurus.config.js
module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        gtag: {
          trackingID: [
            'G-<YOUR-NEW-GA4-ID>',
            'UA-<YOUR-OLD-UA-ID>',
          ],
        },
      },
    ],
  ],
};
Google 即将停用 Universal Analytics

Google 将于 2023年7月1日 停用其 Universal Analytics。

Docusaurus 用户应迁移到 Google Analytics 4。Google 不允许将现有 Universal Analytics 数据迁移到新的 Google Analytics 4 媒体资源。

为保持分析的连续性，我们暂时建议您同时向两个跟踪 ID 报告事件：旧的（UA-*）和新的（G-*）。详情请参阅 专用问题。

开发者体验​

在 #8736 中，我们改进了错误消息的渲染方式，并添加了对渲染错误完整因果链的初步支持（请参阅 ES2022 Error Cause）。

提示

要查看实际效果，请点击此处

在 #8735 中，我们还使导航栏相关的错误消息更加清晰，以帮助用户理解他们的错误。

Docusaurus navbar error message screenshot

翻译​

我们现在可以翻译一些新元素

  • #8677 引入了一个新的 process.env.DOCUSAURUS_CURRENT_LOCALE （实验性），允许您本地化配置文件，包括网站标题、标语、公告栏、baseUrl 等...
  • #8616 允许翻译导航栏和页脚徽标的 `alt` 文本

我们为多种语言添加了默认主题翻译支持

  • 🇭🇺 #8668: 匈牙利语
  • 🇳🇴 #8631: 挪威语（博克马尔语）
提示

完成主题翻译是一项 持续的努力 ，也是为 Docusaurus 贡献的简单方式。我们定期添加新的主题功能，因此我们经常 需要新的翻译。

其他更改​

其他值得注意的更改包括

  • #8674: 遵守 prefers-reduced-motion: reduce 媒体查询
  • #8712: 在模板中使用类型为 docSidebar 的导航栏项目
  • #8801: 允许选项卡子项为假值
  • #8757: 使搜索页面响应外部查询字符串更改
  • #8803: 修复 RTL 模式下代码块按钮的位置
  • #8615: 修复使用深色导航栏时颜色模式切换的问题
  • #8699: 修复导航栏下拉选项卡焦点错误

查看 2.4.0 变更日志条目 以获取完整的变更列表。