Announcement communicates page-related messages. For example, to acknowledge that certain page is getting outdated, or it is being worked on; therefore, to provide transient awareness during the page edition process.

Announcement can be dismissed pressing the close button visible on its right side.

Announcement is less relevant than breakingnews.

Presentation template

Announcement presentation template is defined in the _includes/base/announcements.html file.

Announcement presentation template arranges a bullhorn icon () on the left side and a regular content on the right side.

Configuration files

Announcement presentation template reads configuration variables from configuration files described below:

1. Site’s configuration file:

   _config.yml
   

   Set default values for both site and page-specific configuration variables.

2. Page preamble section of markdown files:

   **/*.md
   

   Set custom values for page-specific configuration variables. Page configuration variables defined in page preamble section of markdown files override page configuration variables defined in site’s configuration file.

Configuration variables

Announcement configuration variables are described in the following table:

The with_announcements_data list items accept the properties described in the table below:

Showing announcement at page level

---
title: This is a page with announcement

with_announcements: true
with_announcements_data:
 - content: My announcement content.
---

Some content here.

To show announcement at page level, do the following:

1. Add with_announcements configuration variable to page preamble in Markdown files with value true.

2. Add with_announcements_data configuration variable to page preamble in Markdown files with content, and others supported property, set to the message you want to communicate.

Showing announcement at page content level

---
title: This is a page with announcements at page content level

with_section_announcements_1:
 - content: This section is under construction!

with_section_announcements_2:
 - content: This section is outdated!
---

## Section 1

{% include base/announcements.html
    announcements = page.with_section_announcements_1
%}

Some content here.

## Section 2

{% include base/announcements.html
    announcements = page.with_section_announcements_2
%}

Some content here.

To show announcement message at page content level, do the following:

1. Add a custom with_<name>_announcements_data page configuration variables in the page preamble of Markdown files. These variables should have the same properties with_announcements_data configuration variable has.

   with_section_announcements_1:
    - content: This section is under construction!
   

2. Include announcement presentation template passing a custom page configuration variable as argument.

   {% include base/announcements.html
       announcements = page.with_section_announcements_1
   %}
   

Showing announcement at site level

To show announcement at site level, set configuration variables in the site configuration file _config.yml, as described in the configuration example below.

# site.defaults - Set global default values.
defaults:
  - scope:
      path: "" # an empty string here means all files in the project.
    values:
      with_announcements: true
      with_announcements_data:
        - content: My announcement content.

Hiding announcement at page level

---
title: This is a page with announcement

with_announcements: false
---

Some content here.

To hide announcement at page level, set with_announcements configuration variable to false in the page preamble of Markdown files.

Hiding announcement at site level

# site.defaults - Set global default values.
defaults:
  - scope:
      path: "" # an empty string here means all files in the project.
    values:
      with_announcements: false

To hide announcement at site level, set with_announcements configuration variable to false in the site configuration file _config.yml, as described in the configuration, under defaults values.

Related topics