IntegrationsNextra

Add Embedded Chat to Nextra

Integrate Inkeep's embedded chat into your Nextra documentation for seamless user interaction.

What is Nextra

Nextra is a framework for creating content-focused websites using Next.js and markdown.

Get an API key

Follow these steps to create an API key for your web integration.

Copy and add the apiKey to your environment variables:

.env
NEXT_PUBLIC_INKEEP_API_KEY="INKEEP_API_KEY"

Install the component library

npm install @inkeep/cxkit-react
yarn add @inkeep/cxkit-react

Customize your settings

Define your Inkeep settings.

Define the component

Create an InkeepEmbeddedChat.tsx file for the Embedded Chat component.

Use the component

Now to add the InkeepEmbeddedChat.tsx component follow these steps:

  1. Create a new page - Ask AI ✨
    touch pages/ask-ai.mdx
  1. Initialize the page in the _meta.json file:
_meta.json
{
  // ...
  "ask-ai": "Ask AI ✨"
  // ...
}
  1. Add a widget to the page:
ask-ai.mdx
# Ask AI
 
import InkeepEmbeddedChat from "@/components/InkeepEmbeddedChat";
 
<InkeepEmbeddedChat />

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

On this page