跳至主要内容

Docusaurus 2.3

·阅读 3 分钟
Sébastien Lorber
Docusaurus 维护者,This Week In React 编辑

我们很高兴地宣布 Docusaurus 2.3

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

Docusaurus 2.2 social card

亮点

Google 标记管理器插件

Google 标记管理器是一个标记管理系统,它提供了极大的灵活性。它使分析和营销团队能够轻松加载其他第三方跟踪器并触发分析标记。

我们现在有一个 @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 标记管理器插件。请参阅 专门的 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.

:::

::::
嵌套警告

您现在可以将一个警告嵌套在另一个警告中!

危险

在有意义的情况下谨慎使用。

博客 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 插件现在使使用自定义逻辑转换显示的搜索结果变得更加容易
  • #8397deploy CLI 现在理解 git url insteadOf 配置

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