Skip to content
Documentation

    Embedding the Page

    The page embed enables you to integrate your portal seamlessly into your website or documentation. You can maintain your existing website header and footer, ensuring a consistent user experience across your site.

    1. Copy the channel ID for the embed widget.

    2. Choose whether to embed the Changelog, the Roadmap, or both by selecting which modules to include in the embed.

      Select which modules to include
      Select which modules to include
    3. Add the following code snippet to the <head> section of your site.

      <script src="https://embed.released.so/1/embed.js" defer></script>
    4. Add the released-page element to your page

      Section titled “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>

      To automatically authenticate users, you can implement user verification and pass in the auth-token attribute.

      <released-page channel-id="CHANNEL_ID" auth-token="AUTH_TOKEN"></released-page>
    1. 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>
    2. If you add <released-page> after your page has loaded, for example once you have a user verification token, add a data-preload attribute to the embed script. The page’s code then downloads while you wait for the token, instead of after it. If you also use the notification badge, list both: data-preload="page badge".

      <script src="https://embed.released.so/1/embed.js" defer data-preload="page"></script>

      If you only know later whether you’ll show the page, call window.Released?.preload('page') from your own code instead. It works once the embed script has run, and returns a promise that resolves when the code has downloaded. It never rejects.

      Only preload elements the visitor will see. If the embed script is on every page of your site, preloading downloads the page’s code on all of them.

    3. 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.

    View an example of how to embed the page on CodePen.