跳到主要内容

Docusaurus 3.1

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

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

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

Docusaurus 博客文章社交卡片

亮点​

破损锚点检查器​

在 #9528 中，我们改进了内置的失效链接检查器，使其也能检测失效锚点。

Docusaurus 博客文章社交卡片

快速失败

出于向后兼容性的原因，新的 onBrokenAnchors 选项默认值为 warn。

我们建议将其设置为 throw，并在部署失效锚点到生产环境之前使您的 CI 构建失败。

备注

对于实现自定义 <Heading> 和 <Link> 组件的用户和插件作者，我们提供了一个新的 useBrokenLinks React hook API。

大多数 Docusaurus 用户不需要关心它，内置组件（docusaurus/Link 和 @theme/Heading）已经在内部使用了它。

parseFrontMatter hook​

在 #9624 中，我们添加了一个新的 siteConfig.markdown.parseFrontMatter 函数 hook 。

这使得可以实现方便的前置 matter 转换、快捷方式，或者使用 Docusaurus 插件不支持的前置 matter 集成外部系统。

docusaurus.config.js
export default {
  markdown: {
    parseFrontMatter: async (params) => {
      // 重用默认解析器
      const result = await params.defaultParseFrontMatter(params);

      // 处理前置 matter 描述占位符
      result.frontMatter.description =
        result.frontMatter.description?.replaceAll('{{MY_VAR}}', 'MY_VALUE');

      // 创建您自己的前置 matter 快捷方式
      if (result.frontMatter.i_do_not_want_docs_pagination) {
        result.frontMatter.pagination_prev = null;
        result.frontMatter.pagination_next = null;
      }

      // 重命名来自另一个系统的不受支持的前置 matter
      if (result.frontMatter.cms_seo_summary) {
        result.frontMatter.description = result.frontMatter.cms_seo_summary;
        delete result.frontMatter.cms_seo_summary;
      }

      return result;
    },
  },
};

阅读 前置 matter 指南 和 parseFrontMatter API 参考 以了解详情。

其他更改​

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

  • #9674 ：添加 siteConfig.markdown.remarkRehypeOptions 以将选项传递给 remark-rehype，允许您自定义脚注标签等内容
  • #9671 ：添加对 (Visual) Basic/Batch/Fortran/COBOL/ML 的代码块 MagicComments 支持
  • #9610 ：通过 PORT 环境变量启用 CLI 端口配置
  • #9477 ：完成巴西葡萄牙语 (pt-BR) 翻译

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