Integrations
Add Inkeep's UI components to your Mintlify docs
Overview
Mintlify is a managed documentation platform with a fresh, modern look.
To add Inkeep's search bar or "Ask AI" chat button to your Mintlify docs, you can use the @inkeep/cxkit-mintlify package.
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.
Add a script to your repo
Create an inkeep.js file at the root of your documentation GitHub repo like the example below.
Customize settings with your API key and other customizations.
function loadScript(url, callback) {
const script = document.createElement("script");
script.src = url;
script.type = "text/javascript";
script.onload = callback;
document.head.appendChild(script);
}
loadScript("https://cdn.jsdelivr.net/npm/@inkeep/cxkit-mintlify@0.5/dist/index.js", () => {
const settings = {
baseSettings: {
apiKey: "INKEEP_API_KEY", // required
primaryBrandColor: "#26D6FF", // required -- your brand color, the color scheme is derived from this
organizationDisplayName: "Inkeep",
// ...optional settings
},
aiChatSettings: {
// ...optional settings
aiAssistantAvatar: "https://mydomain.com/mylogo.svg",
exampleQuestions: [
"Example question 1?",
"Example question 2?",
"Example question 3?",
],
},
};
// Initialize the UI components
Inkeep.ModalSearchAndChat(settings); // Search Bar
Inkeep.ChatButton(settings); // 'Ask AI' button
});