Announcement Banner
Announcement banner allows you put important messages at the top of the page. It supports markdown syntax too.
Options
| Option | Description | Required | Default |
|---|---|---|---|
| id | Announcement id | Yes | - - |
| message | Announcement message, markdown supported | Yes | - - |
Example
{% embed announcement-banner id="0.2.17" message="*New version [0.2.17](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.17) relased*" %}
This book’s announcement banner is enabled, you can see it at the top of this page.
However, you may want to enable it for the whole book. You can do this by adding below options to book.toml file after [preprocessor.embedify] section:
announcement-banner.enable = true
announcement-banner.id = "0.2.17"
announcement-banner.message = "*New version [0.2.17](https://github.com/MR-Addict/mdbook-embedify/releases/tag/0.2.17) relased*"
Note that announcement banner id must be unique, otherwise it won’t be shown if there is another announcement banner with the same id when user closed it.