Show Developer Menu

Embeddable Knowledge Base

Inline Embedding

The embeddable knowledge base is a great way to display help articles and search anywhere on your site. It will render automatically inline and take up the available horizontal screen space (so it works well on mobile devices) and stretch its content vertically.

Widget kb


Make sure you have the Reamaze.js snippet installed from the Installation Step.

<div data-reamaze-embed="kb"></div>

Anywhere on your site, you can simply place an HTML element with a data-reamaze-embed attribute to have it replaced with the inline embedded knowledge base.

Open Specific Article

By default, the Embedded Knowledge Base will load your index. If you'd like the to display a specific Knowledge Base Article by default you can specify the article URL via a data attribute.


<div data-reamaze-embed="kb" data-reamaze-embed-path="/kb/topic/article"></div>

Customizing Knowledge Base Colors and Text/Language

You can personalize your Brand's Reamaze.js Knowledge Base without touching any code! You'll just need to go to Brand Settings to adjust your preferences. The embedded content will then load with your selected color and text settings.

Next Step

If you'd like to embed a content form rather than a knowledge base, it's just a simple change, which we will explain in the next section.

Next: Embeddable Contact Form →