What is Nextra

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

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

Copy and add the apiKey, integrationId and organizationId to your environment variables:

.env
NEXT_PUBLIC_INKEEP_API_KEY="INKEEP_API_KEY"
NEXT_PUBLIC_INKEEP_INTEGRATION_ID="INKEEP_INTEGRATION_ID"
NEXT_PUBLIC_INKEEP_ORGANIZATION_ID="INKEEP_ORGANIZATION_ID"

Install the component library

npm install @inkeep/uikit

Customize your settings

Create a useInkeepSettings.ts file that will contain a hook that will return the configuration for Inkeep component(s).

Make sure to add your Inkeep identifiers to your environment settings.

Define the component

Next, create an InkeepSearchBar.tsx file for the Search Bar component.

To add a widget to the page, paste the code shown below into the theme.config.tsx file:

theme.config.tsx
//...
search: {
  component: () => <InkeepSearchBar />
}
Search bar will be replaced by this widget by default

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