设置头部¶

MkDocs的头部材料可以自定义，以显示一个在滚动时消失的公告栏，并提供一些进一步配置的选项。它还包括搜索栏和一个显示您项目的git仓库的地方，具体内容请参阅这些专门的指南。

配置¶

自动隐藏¶

6.2.0

当启用自动隐藏时，当用户滚动超过某个阈值时，头部会自动隐藏，从而为内容留出更多空间。将以下行添加到mkdocs.yml中：

theme:
  features:
    - header.autohide

公告栏¶

5.0.0

MkDocs的材料包含一个公告栏，这是向用户展示项目新闻或其他重要信息的理想场所。当用户滚动超过头部时，公告栏会自动消失。为了添加公告栏，扩展主题并[覆盖announce块][overriding blocks]，该块默认是空的：

{% extends "base.html" %}

{% block announce %}
  <!-- 在这里添加公告，包括任意HTML -->
{% endblock %}

标记为已读¶

8.4.0

为了呈现可以被用户标记为已读的临时公告，可以包含一个按钮来关闭当前公告。将以下行添加到mkdocs.yml中：

theme:
  features:
    - announce.dismiss

当用户点击按钮时，当前公告会被关闭，并且在公告内容更改之前不会再次显示。这是自动处理的。