本文へスキップ
バージョン: 3.5.2

マークダウンリンク

別のページへのリンクの追加方法は2つあります。URLパスとファイルパスです。

- [URL path to another document](./installation)
- [file path to another document](./installation.mdx)

URLパスはDocusaurusによって処理されず、<a href="./installation">として直接レンダリングされます。つまり、ファイルシステム上の場所ではなく、ページのURLの場所に基づいて解決されます。

同じプラグインによって含まれている別のマークダウンファイルを参照する場合は、リンク先のドキュメントの相対パスを使用できます。Docusaurusのマークダウンローダーは、ファイルパスを対象ファイルのURLパスに変換します（そのため、.md拡張子が削除されます）。

たとえば、docs/folder/doc1.mdにあり、docs/folder/doc2.md、docs/folder/subfolder/doc3.md、およびdocs/otherFolder/doc4.mdを参照する場合

docs/folder/doc1.md
I am referencing a [document](doc2.mdx).

Reference to another [document in a subfolder](subfolder/doc3.mdx).

[Relative document](../otherFolder/doc4.mdx) referencing works as well.

相対ファイルパスは、現在のファイルのディレクトリに対して解決されます。一方、絶対ファイルパスは、通常docs/、blog/、またはローカライズされたもの（例：i18n/zh-Hans/plugin-content-docs/current）であるコンテンツルートに対して解決されます。

絶対ファイルパスはサイトディレクトリを基準にすることもできます。ただし、/docs/または/blog/で始まるリンクは、新しいドキュメントバージョンを作成したりローカライズしたりする場合に手動で更新する必要があるため、移植性がありません。

You can write [links](/otherFolder/doc4.mdx) relative to the content root (`/docs/`).

You can also write [links](/docs/otherFolder/doc4.mdx) relative to the site directory, but it's not recommended.

相対的なURLリンクではなく、相対的なファイルパス（.md拡張子付き）を使用すると、次の利点があります。

  • GitHubインターフェースや多くのマークダウンエディターでリンクが引き続き機能します。
  • すべてのリンクを更新することなく、ファイルのスラグをカスタマイズできます。
  • フォルダ内のファイルの移動はエディターによって追跡でき、一部のエディターではファイルリンクが自動的に更新される場合があります。
  • バージョン管理されたドキュメントは、まったく同じバージョンの別のドキュメントにリンクします。
  • trailingSlash設定を更新すると、相対URLリンクは非常に高い確率で壊れます。
警告

マークダウンファイルの参照は、ソースファイルとターゲットファイルが同じプラグインインスタンスによって処理されている場合にのみ機能します。これは、当社のマークダウン処理アーキテクチャの技術的な制限であり、今後修正される予定です。プラグイン間でファイルにリンクしている場合（例：ブログ投稿からドキュメントページへのリンク）、URLリンクを使用する必要があります。