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

ヘッドメタデータ

ヘッドメタデータのカスタマイズ

Docusaurusは、<html><head><body>に役立つページメタデータを自動的に設定します。Markdownファイルの<head>タグを使用して、追加のメタデータを追加したり、既存のメタデータを上書きしたりできます。

markdown-features-head-metadata.mdx
---
id: head-metadata
title: Head Metadata
---

<head>
<html className="some-extra-html-class" />
<body className="other-extra-body-class" />
<title>Head Metadata customized title!</title>
<meta charSet="utf-8" />
<meta name="twitter:card" content="summary" />
<link rel="canonical" href="https://docusaurus.dokyumento.jp/docs/markdown-features/head-metadata" />
</head>

# Head Metadata

My text

この<head>宣言は、デモとして現在のMarkdownドキュメントに追加されました。ブラウザの開発者ツールを開き、このページのメタデータがどのように影響を受けたかを確認してください。

注記

この機能は、Docusaurusの<Head>コンポーネント上に構築されています。react-helmetを参照して、詳しいドキュメントを確認してください。

通常のSEOには不要です

コンテンツプラグイン(例:ドキュメントとブログ)は、descriptionkeywordsimageなどのフロントマターオプションを提供します。これらはdescriptionog:descriptionの両方に自動的に適用されますが、<head>タグを使用する場合は、2つのメタデータタグを手動で宣言する必要があります。

Markdownページの説明

Markdownページの説明メタデータは、ヘッドメタデータよりも多くの場所で利用できます。たとえば、ドキュメントプラグインの生成されたカテゴリインデックスでは、ドキュメントカードの説明メタデータが使用されます。

デフォルトでは、説明は最初のコンテンツのある行で、プレーンテキストに変換するための処理が施されます。たとえば、次のファイル…

# Title

Main content... May contain some [links](./file.mdx) or **emphasis**.

…のデフォルトの説明は「メインコンテンツ…リンクや強調表示が含まれる場合があります」になります。ただし、**完全に機能するように設計されているわけではありません**。適切な説明を生成できない場合は、フロントマターを使用して明示的に説明を提供できます。

---
description: This description will override the default.
---

# Title

Main content... May contain some [links](./file.mdx) or **emphasis**.