Setting up the header¶

Material for MkDocs' header can be customized to show an announcement bar that disappears upon scrolling, and provides some options for further configuration. It also includes the search bar and a place to display your project's git repository, as explained in those dedicated guides.

Configuration¶

Automatic hiding¶

6.2.0 · Feature flag

When autohiding is enabled, the header is automatically hidden when the user scrolls past a certain threshold, leaving more space for content. Add the following lines to mkdocs.yml:

theme:
  features:
    - header.autohide

Announcement bar¶

5.0.0 · Customization

Material for MkDocs includes an announcement bar, which is the perfect place to display project news or other important information to the user. When the user scrolls past the header, the bar will automatically disappear. In order to add an announcement bar, extend the theme and override the announce block, which is empty by default:

{% extends "base.html" %}

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

Mark as read¶

8.4.0rc1 · Feature flag · Experimental

In order to render temporary announcements that can be marked as read by the user, a button to dismiss the current announcement can be included. Add the following lines to mkdocs.yml:

theme:
  features:
    - announce.dismiss

When the user clicks the button, the current announcement is dismissed and not displayed again until the content of the announcement changes. This is handled automatically.

Scroll to the top of this page to see it in action.