元数据¶

元数据扩展使得可以向文档添加元数据，从而在页面特定的上下文中提供对主题的更多控制。

用法¶

元数据在Markdown文档的开头写为一系列键值对，由结束元数据上下文的空行分隔。

Example:

title: Lorem ipsum dolor sit amet
description: Nullam urna elit, malesuada eget finibus ut, ac tortor.
path: path/to/file
source: file.js

# Headline

...

设置 hero 文字¶

Material 通过元数据公开一个简单的纯文本页面本地英雄，当您滚动到顶部时可以在当前页面上看到。它很简单：

1	hero: Metadata enables hero teaser texts

链接来源¶

当文档与一组特定的源文件相关并且repo_url在项目的mkdocs.yml中定义时，可以使用源键链接文件：

1	source: file.js

文件名附加到mkdocs.yml中设置的repo_url，但可以使用路径作为前缀以确保正确的path解析：

Example:

1 2	path: tree/master/docs/extensions source: metadata.md

Result:

See the source section for the resulting output.

重定向到另一个页面¶

有时需要在导航树中移动文档并将用户从旧URL重定向到新URL。重定向元标记允许创建从当前文档到标记中指定的地址的重定向

例如，如果您的文档包含:

1	redirect: /new/url

访问该文档的URL将自动重定向到 /new/url.

覆盖¶

页面标题¶

可以在每个文档级别覆盖页面标题:

1	title: Lorem ipsum dolor sit amet

这会将当前页面的文档头内的标题标记设置为提供的值。它还将覆盖MkDocs的Material的默认行为，它使用短划线作为页面标题的分隔符来附加站点标题。

页面描述¶

页面描述也可以在每个文档级别上覆盖:

1	description: Nullam urna elit, malesuada eget finibus ut, ac tortor.

这会将包含当前页面文档头内的网站描述的元标记设置为提供的值。

来源

metadata.md