Skip to content

设置页首

MkDocs 的材料可以自定义,以显示一个滚动后消失的公告栏,并提供一些进一步配置的选项。 它还包括搜索栏和一个显示你的项目的[git 仓库]的位置,如在这些专门的指南中所解释的。

配置

自动隐藏

当启用自动隐藏时,用户滚动超过某个阈值时,标题栏会自动隐藏,为内容留出更多空间。将以下行添加到mkdocs.yml

theme:
features:
    - `header.autohide`

公告栏

MkDocs 的材料包括一个公告栏,这是显示项目新闻或其他对用户重要的信息的完美位置。当用户滚动超过标题栏时,该栏将自动消失。为了添加一个公告栏,扩展主题覆盖announce,默认情况下该块是空的:

{% extends "base.html" %} {% block announce %}
<!-- 在这里添加公告,包括任意的HTML -->
{% endblock %}

标记为已读

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

theme:
features:
    - `announce.dismiss`

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

滚动到本页的顶部以查看它的效果。