Header 设置¶

Material-for-MkDocs 的 header 部分可以进行定制，可以显示一个公告栏，在滚动页面时自动消失，并且可以进行一些选项配置。他还包括了搜索框 search bar 和显示项目 Git 代码仓库的 git repository 的地方。在他们各自的模块中会有详细的解释。

配置¶

启用自动隐藏后，当用户屏幕滚动超过一定的阈值时，整个 Header 会自动隐藏，为页面内容留下更多的空间。在 mkdocs.yml 添加下面几行：

theme:
  features:
    - header.autohide

MkDocs Material 主题包括一个公告栏，这是非常好的位置向用户显示项目新闻或其他重要信息。

当用户滚动过标题后，公告将自动消失。为了添加一个公告栏，需要配置 extend the theme 和 override the announceblock，他们默认是空的。

修改路径: overrides/main.html

{% extends "base.html" %}

{% block announce %}
  <!-- Add announcement here, including arbitrary HTML -->
{% endblock %}

用户可以对公告进行已读标记，通过一个按钮来取消当前的公告显示。在 mkdocs.yml 添加如下几行：

theme:
  features:
    - announce.dismiss

当用户单击该按钮时，当前的公告将被关闭，在通知的内容发生变化前不会再次显示。这个过程是自动的。