Add AI Chat to your GitBook docs

What is GitBook

GitBook is a static site generator for docs.

Get an API key

1. Go to the Inkeep Dashboard
2. Select your project under Projects
3. Go to the Integrations tab
4. Click on Create integration
5. Select Web
6. Provide a Name.
7. Specify a URL for where this integration will be used.
8. For production API keys, leave Enforce referrer URL checked.
9. Click on Create
10. Click the Example < /> button to get your API key and view suggested settings

For local or staging API keys, see here.

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:

{
  "apiKey": "INKEEP_API_KEY",
  "integrationId": "INKEEP_INTEGRATION_ID",
  "organizationId": "INKEEP_ORGANIZATION_ID",
  "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.