跳到主要内容

Docusaurus 2.3

· 阅读需 5 分钟
Sébastien Lorber
Sébastien Lorber
Docusaurus maintainer, This Week In React editor

我们很高兴地宣布 Docusaurus 2.3 发布。

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

Docusaurus 2.2 社交卡片

亮点​

Google Tag Manager 插件​

Google Tag Manager 是一个标签管理系统，它允许高度的灵活性。它使分析和营销团队能够轻松加载其他第三方跟踪器并触发分析标签。

我们现在有一个 @docusaurus/plugin-google-tag-manager 包，您可以将其与现有的 gtag.js 插件 一起使用或作为替代方案（请参考 此文档 以了解何时使用哪种解决方案）。

Google 即将停止使用 Universal Analytics

Google 将于 2023 年 7 月 1 日停止使用 Universal Analytics，并要求用户迁移到 Google Analytics 4 。

因此，我们也 弃用现有的 @docusaurus/plugin-google-analytics 包。Docusaurus 用户应该创建一个新的 Google Analytics 4 属性，并迁移到 gtag.js 插件 ，或 Google Tag Manager 插件 。请参考 专门的 Docusaurus 问题 了解更多详情和问题。

标签查询字符串支持​

现在可以将选定的标签链接到查询字符串参数。选择标签后，它将作为 ?qs-param=tab-value 搜索参数存储在您的浏览器 URL 中。

此功能允许深层链接到页面加载时预先选择的特定文档标签。

当与 groupId 属性一起使用时，查询字符串标签值优先于 localStorage 值。

请务必查看 文档 和下面的演示，以了解其工作原理：

<Tabs groupId="current-os" queryString>
  <TabItem value="android" label="Android">
    Android
  </TabItem>
  <TabItem value="ios" label="iOS">
    iOS
  </TabItem>
</Tabs>
http://localhost:3000

Android

嵌套警告框​

现在可以通过为外部/封闭警告框添加额外的冒号来在一个警告框内嵌套另一个警告框：

::::tip[nested admonitions]

You can now nest one admonition within another!

:::danger

Use this sparingly when it makes sense.

:::

::::
nested admonitions

You can now nest one admonition within another!

危险

Use this sparingly when it makes sense.

博客 createFeedItems​

新的博客插件选项 feedOptions.createFeedItems 提供了对 RSS/Atom 源生成的更多控制。现在可以通过新的回调来转换/过滤/限制源项目。

docusaurus.config.js
[
  '@docusaurus/preset-classic',
  {
    blog: {
      feedOptions: {
        createFeedItems: async (params) => {
          const {blogPosts, defaultCreateFeedItems, ...rest} = params;
          return defaultCreateFeedItems({
            // keep only the 10 most recent blog posts in the feed
            blogPosts: blogPosts.filter((item, index) => index < 10),
            ...rest,
          });
        },
      },
    },
  },
];

翻译​

我们添加或完成了对多种语言的默认主题翻译支持：

  • 🇸🇮 #8541 斯洛文尼亚语
  • 🇹🇷 #8289 土耳其语
  • 🇮🇷 #8406 波斯语
  • 🇵🇱 #8525 波兰语
  • 🇨🇳 #8423 中文
  • 🇸🇪 #8312 瑞典语
  • 🇻🇳 #8450 越南语
提示

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

其他更改​

其他值得注意的更改包括：

  • #8463 和 #8328 ：修复了一些恼人的 Docusaurus 布局问题
  • #8539 ：Algolia 插件 options.searchPagePath 应正确应用于搜索模式页脚
  • #8462 ：Algolia 插件现在使使用自定义逻辑转换显示的搜索结果变得更容易
  • #8397 ：deploy CLI 现在理解 git url insteadOf 配置

查看 2.3.0 更新日志 以获取所有更改的详尽列表。