Embedding the Page
Embed the page in your website or documentation with a few lines of code.
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.
Installation instructions
Copy the channel ID
Copy the channel ID for the embed widget.
Add the released-page element to your page
Add the following code snippet to the <body> section of your site. Unlike the widget, the page content renders where you position the element. Ensure you replace the CHANNEL_ID attribute.
<released-page channel-id="CHANNEL_ID"></released-page>If your portal has restricted access, you’ll need to implement user verification and pass the auth-token="AUTH_TOKEN" attribute to display content in your embed.
Optional steps
Add a 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 embedded page. This badge functions similarly to the notification badge found in the widget.
Add the following code snippet to the <body> section of your site where you want the badge to render.
<released-badge channel-id="CHANNEL_ID"></released-badge>Customize the page
Customize the page to match your brand and app design using the page properties. Adjust the title and description, or change the colors according to your preferences.
Please see the documentation for a full list of configuration options.
Example
View an example of how to embed the page on CodePen.
Last updated
Was this helpful?