跳至主要内容
版本: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.org.cn/docs/markdown-features/head-metadata" />
</head>

# Head Metadata

My text

<head> 声明已添加到当前 Markdown 文档中作为演示。打开浏览器开发者工具并检查此页面的元数据是如何受到影响的。

注意

此功能构建在 Docusaurus 的 <Head> 组件之上。有关详尽的文档,请参阅 react-helmet

您不需要为常规 SEO 使用此功能

内容插件(例如文档和博客)提供诸如 descriptionkeywordsimage 之类的前置 matter 选项,这些选项将自动应用于 descriptionog:description,而使用 <head> 标签时,您需要手动声明两个元数据标签。

Markdown 页面描述

Markdown 页面的描述元数据可能用于比头部元数据更多的地方。例如,文档插件的 生成的类别索引 使用文档卡片的描述元数据。

默认情况下,描述是第一行内容行,并经过一些处理将其转换为纯文本。例如,以下文件...

# Title

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

...的默认描述将为“主要内容...可能包含一些链接或强调”。但是,**它并非旨在完全可用**。在无法生成合理描述的情况下,您可以通过前置 matter 显式提供一个描述

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

# Title

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