Scroll Viewport for Confluence

Add Release Notes to your Scroll Viewport help centre.

Scroll Viewport is an Atlassian marketplace app by K15t that allows you to transform your documentation in Confluence into a public or restricted online help center for your users.

Released now integrates with Scroll Viewport through their custom JavaScript inject feature. Setting up this integration is a breeze and requires just a few simple steps, taking less than 5 minutes to complete.

Installation

1

Get the Released Channel ID

Find the channel ID for the announcement page and note it down.

2

Create a placeholder page in Confluence

  • Create a page where you want the release notes to appear in your Viewport documentation.

  • Give the page your preferred name, e.g. "Release Notes".

  • Leave the page empty and save.

3

Get the Confluence Page ID

Note down the Confluence Page ID from the URL (see screenshot below).

Note down the Confluence page ID from the URL
4

Add the custom JavaScript snippet to your Viewport theme

  1. Navigate to your Viewport theme settings.

if (vp.source.confluencePageId === "PAGE_ID") {
  vp.loadScript('https://embed.released.so/1/embed.js').then(() => {
    document.getElementById("article-content").innerHTML = '<released-page channel-id="CHANNEL_ID" color-scheme="light" color-scheme="light" top-offset="80px" color-primary="#FFF"></released-page>'
  });
}

Ensure you replace the Page_ID and CHANNEL_ID placeholders with the IDs noted in the previous steps.

5

Save changes

Click save, and you're done! 🎉

Optional style fine-tuning

By default, Scroll Viewport adds a 10cm padding at the top of the page. To remove the padding on your release page, you can inject the following CSS in the theme settings:

#article-content:has(> released-page)
{
    padding-top:0px;
    grid-template-columns:1fr;
}

Congratulations, you're done 🎉

New posts published with Released will now automatically appear in your Viewport help centre.

Last updated

Was this helpful?