IntegrationsGitbook

Add Chat Button to GitBook

Integrate Inkeep's chat button into your GitBook documentation for real-time user assistance.

What is GitBook

GitBook is a static site generator for docs.

Get an API key

Follow these steps to create an API key for your web integration.

Installing widget for your website

  1. Navigate to GitBook
  2. Click Install
  3. After installation, navigate to Docs sites tab and enable the widget for your desired site

Initialize the widget

Navigate to the Configuration tab to customize your settings.

The Base Widget Setting is required for the widget to function. Your configuration should resemble the example below:

baseSettings
{
  "apiKey": "INKEEP_API_KEY",
  "primaryBrandColor": "#26D6FF",
  "organizationDisplayName": "Inkeep"
}

Once the configuration is applied, the widget will appear on the site you enabled the widget for.

For a full list of customizations, check out the Chat Button documentation.

On this page