Announcement

Display an announcement banner at the top of the page.


When there’s something to announce, you can include the announcement content in the conf.py announcement option.

conf.py
html_theme_options = {
  "announcement": "The content of the announcement",
}

Note

HTML is allowed in the announcement option.

Here shows an example with announcement configuration.

../../_images/homepage-light.jpg ../../_images/homepage-dark.jpg