Skip to main content

Embedding guides into your knowledge base or website

Updated over 4 months ago

Guides can be embedded directly into your existing knowledge base or website, making it easy to share guides with your team, right where they work. You can embed guides on platforms like SharePoint, Confluence and any other site that accepts HTML iframe embeds.

Why embed a guide?

Embedding guides allows you to:

  • Always show the latest version of the guide

  • Keep documentation centralized within your tools

  • Reduce context switching by letting users view step-by-step guides without them having to leave the page
    ​

What does an embedded guide look like?

Guides can be embedded in two formats:

  • Slideshow mode - Presents one step at a time, making it perfect for guiding users through a process in a clear, focused sequence.
    ​

  • Scroll mode - Displays all steps in a continuous scroll.
    ​

How to embed a guide?

Guides can be embedded into any platform that supports HTML iframe embeds. This includes tools like SharePoint, Confluence and most modern websites. Copy the embed code from the guide page and paste it into any section of your platform that accepts the HTML or iframe content.

Read our guides about specifically embedding into SharePoint or Confluence:

Did this answer your question?