Page Embed
Embed announcements into your website or documentation
Overview
The announcement page enables you to integrate release notes seamlessly into your website or documentation. You can maintain your existing website header and footer, ensuring a consistent user experience across your site.
Basics
Demo
Experience a demo of the widget on CodePen.
Configuration
The announcement page settings provide a number of options to customize the appearance of the page.
Via the right-hand sidebar settings, you are able to change the title and subtitle, color scheme and locale of the page.
Supported locales
πΊπΈ American English π©πͺ German π«π· French πͺπΈ Spanish π΅πΉ Portuguese π³π± Dutch
Installation
To add the announcement page to your website, simply follow the installation instructions in the app.
Navigate to the Released Settings in your Jira project
Click the Announcement Page menu item.
Click the Install button at the bottom of the sidebar.
Follow the installation instruction in the slide out panel.
Advanced options
Overwriting the UI settings
You can overwrite the configured styles and settings of the page by adding custom properties to the embed code. This allows for customizing the styling when embedding the page in different locations.
When a setting is configured via the properties below, it can no longer be customized via the UI settings.
The properties are specified as attributes within the <released-page>
custom HTML element.
Page properties
Property | Description |
---|---|
| The ID of the release notes channel. |
| Can be "true" or "false". If false, the header with the title and description is hidden. This options allows you use an existing header or create a completely custom header. |
| Can be "true" or "false". Default is "true" and the cover image will be shown. |
| The title of the widget. |
| The subtitle of the widget. |
| The color scheme to use for the widget. Can be |
| The primary UI color. Can be hex, hsl, rgb, or css color name. |
| Expects a number (eg. |
Notification badge
To notify users about the availability of a new post, you can enhance the user experience by incorporating a notification badge on the link or button leading to the announcement page. This badge functions similarly to the notification badge found in the widget.
Installing the badge
Follow the Installation instructions and copy the code for the badge.
It's best to place the <release-badge>
element inside the <a>
tag when adding the badge to a link.
Adjusting the position of the badge
You can adjust the position of the badge by styling it with CSS. We recommend two options:
Use the margin property to adjust the position
Use the transform property to adjust the position
Experiment with badge positioning on CodePen.
Last updated