ReadMe’s Custom Code settings add HTML to every page of your hub. You paste the widget snippet there.

Before you start

  • Your website widget. Kelu makes one for you when you create a knowledge base. Its Install tab shows these steps with your widget id and key already in the code.
  • Your hub on the widget’s Sites it works on list (Install tab), for example https://yourproject.readme.io or your custom domain.
  • Custom JavaScript on your ReadMe plan. If the Custom Code fields are missing or read-only, your plan does not include it.

Add the widget

1

Open Custom Code

In your ReadMe dashboard, select the project and go to Customization → Custom Code. Older projects show it under Appearance → Custom Code.
2

Paste the snippet into Footer HTML

<script async src="https://widget.kelu.dev/kelu-widget.js"
  data-widget-id="YOUR_WIDGET_ID"
  data-client-key="kl_pk_..."></script>
Use your widget’s own snippet, or replace YOUR_WIDGET_ID and kl_pk_... with its values.
3

Save

Click Save.

Check it works

Open any page of the hub. A round icon button appears in the bottom-right corner, with the tooltip Ask AI. Ask a question and check that the answer lists its Sources. ReadMe caches pages, so hard-refresh if nothing shows at first. Still nothing? See Troubleshooting.
ReadMe’s search also opens with Cmd+K. Turn off Open with Cmd/Ctrl+K on the widget’s Search & opening tab so only one opens.