11、头元数据
头元数据
自定义头部元数据
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.nodejs.cn/docs/markdown-features/head-metadata" />
</head>
# Head Metadata
My text
此 <head>
声明已作为演示添 加到当前 Markdown 文档中。打开浏览器 DevTools 并检查此页面的元数据受到的影响。
提示
此功能构建在 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**.
...将有默认描述“主要内容...可能包含一些链接或强调”。然而,它的设计并不是为了实现完整的功能。如果无法提供合理的描述,你可以通过 Front Matter 明确提供:
---
description: This description will override the default.
---
# Title
Main content... May contain some [links](./file.mdx) or **emphasis**.