VitePress
Chat Button
Add AI chat to your VitePress documentation.
What is VitePress
VitePress is a lightweight static site generator based on Vue.
Load the script files
Add the below scripts to the config.ts
file:
config.ts
export default {
head: [
[
"script",
{
src: "https://unpkg.com/@inkeep/widgets-embed@0.2.277/dist/embed.js",
type: "module",
defer: true,
},
],
["script", { src: "addInkeep.js", type: "module", defer: true }],
],
};
Create the addInkeep.js script
Create an addInkeep.js
file in your public
folder.
touch public/addInkeep.js
Now, configure the chat button component.
addInkeep.js
// Embed the widget using the `Inkeep.embed()` function.
const config = {
componentType: "ChatButton",
// optional -- for syncing UI color mode
colorModeSync: {
observedElement: document.documentElement,
isDarkModeCallback: (el) => {
return el.classList.contains("dark");
},
colorModeAttribute: "class",
},
properties: {
chatButtonType: "ICON_TEXT",
baseSettings: {
apiKey: "YOUR_API_KEY",
integrationId: "YOUR_INTEGRATION_ID",
organizationId: "YOUR_ORGANIZATION_ID",
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
botAvatarSrcUrl: "/img/logo.svg", // use your own bot avatar
quickQuestions: [
"Example question 1?",
"Example question 2?",
"Example question 3?",
],
},
},
};
const inkeepWidget = Inkeep().embed(config);
For a full list of customizations, check out the Chat Button documentation.