mkdocs-material/docs/setup/setting-up-the-header.md

56 lines
1.7 KiB
Markdown
Raw Normal View History

---
template: overrides/main.html
---
# 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.
2021-10-10 22:04:22 +03:00
It also includes the [search bar] and a place to display your project's
[git repository], as explained in those dedicated guides.
2021-10-10 22:04:22 +03:00
[search bar]: setting-up-site-search.md
[git repository]: adding-a-git-repository.md
## Configuration
### Automatic hiding
2021-10-10 22:04:22 +03:00
[:octicons-tag-24: 6.2.0][Automatic hiding support] ·
:octicons-unlock-24: Feature flag
2021-10-10 22:04:22 +03:00
When autohiding is enabled, the header is automatically hidden when the
user scrolls past a certain threshold, leaving more space for content. Add the
2021-01-31 21:23:28 +03:00
following lines to `mkdocs.yml`:
``` yaml
theme:
features:
- header.autohide
```
2021-10-03 21:28:52 +03:00
[Automatic hiding support]: https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.0
### Announcement bar
2021-10-10 22:04:22 +03:00
[:octicons-tag-24: 5.0.0][Announcement bar support] ·
:octicons-file-symlink-file-24: Customization
2021-10-03 21:28:52 +03:00
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
2021-10-10 22:04:22 +03:00
an announcement bar, [extend the theme] and [override the `announce`
block][overriding blocks], which is empty by default:
``` html
{% extends "base.html" %}
{% block announce %}
2021-10-10 22:04:22 +03:00
<!-- Add announcement here, including arbitrary HTML -->
{% endblock %}
```
2021-10-15 10:33:18 +03:00
[Announcement bar support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
2021-10-10 22:04:22 +03:00
[extend the theme]: ../customization.md#extending-the-theme
[overriding blocks]: ../customization.md#overriding-blocks