Docusaurus 3.1

Docusaurus 3.1 を発表いたします。

アップグレードは簡単です。リリースプロセスに関するドキュメントで説明されているように、マイナーバージョンはセマンティックバージョニングを遵守しています。

ハイライト

壊れたアンカーチェッカー

#9528では、組み込みの壊れたリンクチェッカーを改善し、壊れたアンカーも検出するようにしました。

早期エラー検出

下位互換性を維持するため、新しいonBrokenAnchorsオプションのデフォルト値はwarnです。

本番環境に壊れたアンカーをデプロイする代わりに、throwに設定してCIビルドを失敗させることをお勧めします。

注記

カスタムの<Heading>および<Link>コンポーネントを実装するユーザーとプラグイン作成者向けに、新しいuseBrokenLinks ReactフックAPIを提供します。

ほとんどのDocusaurusユーザーはこれを気にする必要はありません。組み込みコンポーネント（docusaurus/Linkおよび@theme/Heading）はすでに内部的にこれを使用しています。

parseFrontMatter フック

#9624では、新しいsiteConfig.markdown.parseFrontMatter関数フックを追加しました。

これにより、便利なフロントマターの変換、ショートカットを実装したり、Docusaurusプラグインがサポートしていないフロントマターを使用して外部システムと統合したりすることが可能になります。

docusaurus.config.js

export default {
  markdown: {
    parseFrontMatter: async (params) => {
      // Reuse the default parser
      const result = await params.defaultParseFrontMatter(params);

      // Process front matter description placeholders
      result.frontMatter.description =
        result.frontMatter.description?.replaceAll('{{MY_VAR}}', 'MY_VALUE');

      // Create your own front matter shortcut
      if (result.frontMatter.i_do_not_want_docs_pagination) {
        result.frontMatter.pagination_prev = null;
        result.frontMatter.pagination_next = null;
      }

      // Rename an unsupported front matter coming from another system
      if (result.frontMatter.cms_seo_summary) {
        result.frontMatter.description = result.frontMatter.cms_seo_summary;
        delete result.frontMatter.cms_seo_summary;
      }

      return result;
    },
  },
};

詳細は、フロントマターガイドとparseFrontMatter APIリファレンスをご覧ください。

その他の変更点

その他の注目すべき変更点は以下のとおりです。

• #9674: remark-rehypeにオプションを渡すためにsiteConfig.markdown.remarkRehypeOptionsを追加し、MDX脚注ラベルなどをカスタマイズできるようにしました
• #9671: (Visual) Basic/Batch/Fortran/COBOL/MLのコードブロックMagicCommentsのサポートを追加
• #9610: PORT環境変数を介したCLIポート設定を有効化
• #9477: ブラジルポルトガル語（pt-BR）の翻訳を完了

変更点の完全なリストについては、3.1.0 changelog entry を確認してください。