本文へスキップ

Docusaurus 3.4

·4 分で読む
Sébastien Lorber
セバスチャン・ロルバー
Docusaurus メインテナー、This Week In React エディター

Docusaurus 3.4 のリリースをお知らせできることを嬉しく思います。

アップグレードは簡単です。当社のリリースプロセスはセマンティックバージョニングを尊重しています。マイナーバージョンには破壊的変更が含まれていません。

Docusaurus blog post social card

ハイライト​

タグファイル​

ドキュメントとブログプラグインはどちらもすでにtagsフロントマター属性をサポートしており、関連するコンテンツをグループ化できます。しかし、フロントマターにインラインで宣言されたタグは常に理想的とは限りません。

#10137により、tags.ymlファイルで事前に定義されたタグのリストを宣言できるようになりました。

blog/tags.yml
tag1:
  label: 'Tag 1'
  description: 'Tag 1 description'
  permalink: /tag-1-permalink

tag2:
  label: 'Tag 2'
  description: 'Tag 2 description'
  permalink: /tag-2-permalink

これらの事前に定義されたタグは、ブログまたはドキュメントファイルのフロントマターで使用できます。

blog/2024-05-31-my-blog-post.md
---
tags: [tag1, tag2]
---

# Title

Content
タグの使用の一貫性を維持する

新しいonInlineTags: 'throw'プラグインオプションを使用して、事前に定義されたタグの使用を強制し、貢献者が不要な新しいタグを作成するのを防ぎます。

ハッシュルーター - 試験段階​

9859で、試験段階の新しいハッシュルーター構成オプションを追加しました。これは、file://プロトコルを介してローカルでサイトを開くことで、オフラインブラウジングに役立ちます。

docusaurus.config.js
export default {
  future: {
    experimental_router: 'hash',
  },
};
警告

このモードは、ウェブサーバーを介してデプロイされたサイトには推奨されません。

このモードが有効になっている場合、Docusaurusは静的サイトレンダリングをオプトアウトし、すべてのルートに/#/が接頭辞として付加されたクライアント側のシングルページアプリケーションを構築します。単一のindex.htmlファイルが生成されます。このファイルは、ブラウザのfile://プロトコルを使用して、単にクリックするだけでローカルのブラウザで開くことができます。これにより、読者がコンピューターに複雑なものをインストールする必要なく（ウェブブラウザを除く）、Docusaurusサイトを.zipファイルとして配布して、オフラインで閲覧できるようにすることができます。

Docusaurus hash router - local browsing using the file:// protocol

ハッシュルーターを使用して構築された独自のDocusaurusサイトを参照してみてください。

試験段階

この機能は試験段階です。お試しいただいた場合は、その動作状況をこちらでお知らせください。

サイトストレージ - 試験段階​

Docusaurusは、ブラウザのlocalStorage APIを使用してUIの状態を保持します。

しかし、ストレージスペースが同じドメインを使用する複数のサイト間で「共有」される場合があり、ストレージキーの競合が発生することがあります。これは一般的に次の2つのケースで発生します。

  • 複数のhttp://localhost:3000サイトで作業する場合
  • 同じドメイン下に複数のサイトをホストする場合：https://example.com/site1/とhttps://example.com/site2/

このため、新しい試験段階のsiteStorage構成オプションを導入しました。

export default {
  future: {
    experimental_storage: {
      type: 'localStorage',
      namespace: true,
    },
  },
};

namespace: trueが設定されている場合、すべてのストレージキーにハッシュサフィックスを適用して、現在のサイト（config.urlとconfig.baseUrlに基づく）に対して一意にします。たとえば、themeストレージキーはtheme-x6fになります。独自の カスタムサフィックスnamespace: 'suffix'を提供することも可能です。デフォルトのlocalStorageの代わりにtype: 'sessionStorage'を使用することも可能にしました。

試験段階

この機能は試験段階です。お試しいただいた場合は、その動作状況をこちらでお知らせください。

その他の変更点​

その他の注目すべき変更点には以下が含まれます。

  • #10151: トルクメン語（tk）テーマの翻訳を追加
  • #10111: ブルガリア語（bg）テーマの翻訳を追加
  • #10168: 長期にわたって放置されていた多くのMarkdownリンク解決のバグを修正
  • #10178: /searchページがcontextualSearch: false設定を尊重するようになりました。
  • #10118: 生成されたドキュメントのインデックスカテゴリカードの説明における不適切な複数形を修正
  • #10130: 末尾のスラッシュによる壊れたアンカーチェッカーによる誤検知を修正

変更点の完全なリストについては、3.4.0変更ログエントリを確認してください。