Add AI to GitBook

Integrate the Kapa Website Widget into your GitBook documentation to enable users to ask natural language questions about your product, significantly enhancing user experience by providing quick and accurate answers.

Prerequisites

Before adding the widget to your GitBook site, you'll need to:

1. Ensure you have a Kapa project set up with your knowledge sources added
2. Follow the general installation instructions to enabled your domain and obtain your Website ID

Installation

1. Install the Kapa GitBook plugin in your GitBook space
2. Configure the plugin with your project parameters through the GitBook UI:
   • Website ID: Obtain this ID from the kapa.ai team for your website
   • Native AI experience (optional): Toggle this setting to enable GitBook's built-in AI experience integration
     • When set to true: Kapa AI appears as a native "Ask Kapa AI" button in GitBook's top navigation bar, providing a seamless integrated experience
     • When set to false (default): Kapa AI displays as a floating widget button in the bottom-right corner of your documentation
   • Project Name
   • Project Color
   • Project Logo URL
3. Publish your changes to apply the configuration

Native AI Experience

GitBook now offers a Native AI experience option that integrates Kapa AI directly into GitBook's interface. When enabled, users will see an "Ask Kapa AI" button in the top navigation bar instead of the floating widget, creating a more seamless documentation experience.

Customization Options

To tailor the widget to your brand and specific needs, visit our Configuration page. You'll find detailed instructions on how to adjust colors, logos, and other widget properties through the GitBook plugin settings.

note

You may need to trigger a rebuild of your GitBook space to ensure the changes take effect. This can be done by publishing any change to your documentation.