​
What is Document360

Document360 an AI-powered knowledge base software to create internal and public knowledge bases.

​
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 and URL (optional) for the integration
  7. Click on Create
  8. Click the Example < /> button to get your API key and view suggested settings

​
Initialize the widget

To integrate the Inkeep search bar into your Document360 documentation, follow these steps:

  1. On the Home page remove the default search bar from the Hero section
  2. Go to the page where you want to display the widget and create a new Custom code section with the following html code:
<div id="inkeepSearchBar"></div>
  1. Navigate to Custom CSS / Javascript settings.
  2. Click on the Javascript tab.
  3. Add the following script to disable default search bar and load the inkeep one:
document.addEventListener("DOMContentLoaded", () => {
  // Load the Inkeep script
  const inkeepScript = document.createElement("script");
  inkeepScript.src = "https://unpkg.com/@inkeep/uikit-js@0.3.13/dist/embed.js";
  inkeepScript.type = "module";
  inkeepScript.defer = true;
  document.head.appendChild(inkeepScript);

  // Function for customizing the widget configuration
  const inkeepConfig = (targetElementId) => ({
    componentType: "SearchBar",
    targetElement: targetElementId,
    properties: {
      baseSettings: {
        apiKey: "INKEEP_API_KEY", // required
        integrationId: "INKEEP_INTEGRATION_ID", // required
        organizationId: "INKEEP_ORGANIZATION_ID", // required
        primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
        organizationDisplayName: "Inkeep",
        // ...optional settings
        theme: {
          // stylesheetUrls: ['/path/to/stylesheets'], // optional
          // ...optional settings
        },
      },
      modalSettings: {
        // optional settings
      },
      searchSettings: {
        // optional settings
      },
      aiChatSettings: {
        // optional settings
        botAvatarSrcUrl: "/img/logo.svg", // use your own bot avatar
        quickQuestions: [
          "Example question 1?",
          "Example question 2?",
          "Example question 3?",
        ],
      },
    },
  });

  const addInkeepWidget = () => {
    Inkeep().embed(inkeepConfig("#inkeepSearchBar"));

    const observer = new MutationObserver((mutationsList, observer) => {
      const inkeepPortals = document.getElementsByTagName("inkeep-portal");
      
      Array.from(inkeepPortals)?.forEach((inkeepPortal) => {
        inkeepPortal.remove();
      });

      inkeepConfig("#inkeepSearchBar").targetElement = search;
      
      Inkeep().embed(inkeepConfig("#inkeepSearchBar"));
    });

    observer.observe(document.head, { childList: true });
  };

  inkeepScript.addEventListener("load", addInkeepWidget);
});

For a full list of customizations, check out the Search Bar documentation.

Chat ButtonChat Button & Search Bar