头部元数据
自定义头部元数据
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
内容插件(例如文档和博客)提供前置元数据选项,例如 `description`、`keywords` 和 `image`,它们将自动应用于 `description` 和 `og:description`。而当您使用 <head>
标签时,您将不得不手动声明两个元数据标签。
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**.