Docusaurus 2.3
我们很高兴宣布 Docusaurus 2.3。
升级应该很容易:正如我们在发布流程文档中解释的,次要版本遵循语义化版本控制。
亮点
Google 标签管理器插件
Google 标签管理器是一个标签管理系统,提供了极大的灵活性。它使分析和营销团队能够轻松加载其他第三方跟踪器并触发分析标签。
我们现在有了一个 @docusaurus/plugin-google-tag-manager
软件包,您可以将其与现有 gtag.js 插件 一起使用,或作为其替代方案(请参阅 此文档 以了解何时使用哪种解决方案)。
Google 将于 2023 年 7 月 1 日 停用其通用分析,并要求用户迁移到 Google Analytics 4。
因此,我们也将 弃用现有的 @docusaurus/plugin-google-analytics
软件包。Docusaurus 用户应创建新的 Google Analytics 4 媒体资源,并迁移到 gtag.js 插件 或 Google 标签管理器插件。有关详细信息和问题,请参阅专门的 Docusaurus issue。
选项卡查询字符串支持
现在可以将选定的选项卡链接到查询字符串参数。当选项卡被选中时,它将作为 ?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>
- 安卓
- iOS
安卓
iOS
嵌套提示框
现在可以通过为外部/封闭提示框添加额外的冒号来嵌套提示框。
::::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/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,
});
},
},
},
},
];
翻译
我们添加或完善了对多种语言的默认主题翻译支持
其他更改
其他值得注意的更改包括
- #8463 和 #8328:修复了一些恼人的 Docusaurus 布局问题
- #8539:Algolia 插件
options.searchPagePath
应正确应用于搜索模态框底部 - #8462:Algolia 插件现在使通过自定义逻辑转换显示的搜索结果变得更加容易
- #8397:
deploy
CLI 现在理解 git urlinsteadOf
配置
查看 2.3.0 更改日志条目 以获取完整的更改列表。