设置页头¶
可以自定义 Material for MkDocs 的页头以显示滚动时消失的公告栏,并提供一些用于进一步配置的选项。它还包括搜索栏和显示项目的 git 存储库的位置,如这些专用指南中所述。
配置¶
自动隐藏¶
启用自动隐藏后,当用户滚动超过特定阈值时,标头会自动隐藏,从而为内容留出更多空间。将以下行添加到 mkdocs.yml:
theme:
features:
- header.autohide
公告栏¶
Material for MkDocs 包括一个公告栏,这是向用户显示项目新闻或其他重要信息的理想场所。当用户滚动过标题时,该栏将自动消失。要添加公告栏,请扩展主题并覆盖 announce 块,默认情况下该块为空:
{% extends "base.html" %}
{% block announce %}
<!-- Add announcement here, including arbitrary HTML -->
{% endblock %}
标记为已读¶
为了呈现可标记为用户已读的临时公告,可以包含一个用于关闭当前公告的按钮。将以下行添加到 mkdocs.yml:
theme:
features:
- announce.dismiss