Add an Embedded Chat to your VuePress docs

What is VuePress

VuePress a markdown-centered static site generator.

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.

Load the script files

Navigate to the .vuepress directory
Add the below scripts to the config.js file:

config.js

export default {
  head: [
    [
      "script",
      {
        src: "https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5/dist/embed.js",
        type: "module",
        defer: true,
        onLoad: "initializeInkeep()",
      },
    ],
    ["script", { src: "js/addInkeep.js", type: "module", defer: true }],
  ],
};

Create the addInkeep.js script

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

touch public/js/addInkeep.js

Create container for embedded chat

To create a container for the embedded chat component, navigate to your desired page and add the following code:

<ClientOnly>
  <div id="inkeepEmbeddedChat"></div>
</ClientOnly>

Configure the component

Next, configure the Inkeep widget:

addInkeep.js

const initializeInkeep = () => {
  const addInkeepWidget = () => {
    const embeddedContainer = document.querySelector("#inkeepEmbeddedChat");
 
    if (!embeddedContainer) return;
 
    const inkeepWidget = Inkeep.EmbeddedChat("#inkeepEmbeddedChat", {
      baseSettings: {
        apiKey: "INKEEP_API_KEY", // required
        primaryBrandColor: "#26D6FF",
        organizationDisplayName: "Inkeep",
        colorMode: {
          sync: {
            target: document.documentElement,
            attributes: ["data-md-color-scheme"],
            isDarkMode: (attributes) => {
              const currentTheme = attributes["data-md-color-scheme"];
              return currentTheme === "dracula" || currentTheme === "dark";
            },
          },
        },
      },
    });
  };
 
  if (document.readyState === "loading") {
    document.addEventListener("DOMContentLoaded", addInkeepWidget);
 
    return;
  }
 
  addInkeepWidget();
};

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