Add AI Chat to your Hugo docs

Overview

In this integration example, we will be integrating Inkeep widget into Ananke theme, which is the default theme used as an example with Hugo.

What is Hugo

Hugo is a popular open-source static site generator often used for documentation.

Get an API key

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

For local or staging API keys, see here.

Create the baseof.html file

Create an baseof.html file at the path layouts/_default

touch layouts/_default/baseof.html

Copy the contents of the baseof.html file:

cp themes/ananke/layouts/_default/baseof.html layouts/_default/baseof.html

Note

Depending on your Hugo theme, this step may differ. The goal is to be able to insert custom scripts into your sites <head> tag.

Load the script files

In the baseof.html file, locate the head tag and paste the scripts below at the end:

baseof.html

<head>
  <!-- Other code -->
  <script
    src="https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5/dist/embed.js"
    type="module"
    defer
  ></script>
 
  <script src="/js/addInkeep.js" defer></script>
</head>

Create the addInkeep.js script

Create an addInkeep.js file in your static/js folder.

touch static/js/addInkeep.js

Now, configure the chat button component.

addInkeep.js

const inkeepWidget = Inkeep.ChatButton({
  baseSettings: {
    apiKey: "INKEEP_API_KEY", // required
    primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
    organizationDisplayName: "Inkeep",
    // ...optional settings
  },
  modalSettings: {
    // optional settings
  },
  searchSettings: {
    // optional settings
  },
  aiChatSettings: {
    // optional settings
    aiAssistantAvatar: "/img/logo.svg", // use your own ai assistant avatar
    exampleQuestions: [
      "Example question 1?",
      "Example question 2?",
      "Example question 3?",
    ],
  },
});

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