Skip to main content

Add AI to ReadMe Documentation

Integrate the kapa.ai chat widget into your ReadMe 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 ReadMe site, you'll need to:

  1. Ensure you have a kapa.ai project set up with your knowledge sources added
  2. Follow the general installation instructions to enable your domain and obtain your Website ID
  3. Have admin access to your ReadMe documentation dashboard

Installation​

  1. Log in to your ReadMe dashboard
  2. Navigate to Customization > Custom Code > Footer HTML
  3. In the code editor, add the following script:
<script
  src="https://widget.kapa.ai/kapa-widget.bundle.js"
  data-website-id="XXX-XXX-XXX"
  data-project-name="PROJECT_NAME"
  data-project-color="#HEX_COLOR_CODE"
  data-project-logo="https://LINK_TO_LOGO.com/logo.png"
  async
></script>
  1. Click Save Changes

The widget should now appear on all pages of your ReadMe documentation.

Customization Options

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