@inkeep/cxkit-docusaurus

A Docusaurus plugin that integrates Inkeep Chat Button and Search Bar components into your documentation site.

Installation

``bash
npm install @inkeep/cxkit-docusaurus


or

yarn add @inkeep/cxkit-docusaurus

or

pnpm add @inkeep/cxkit-docusaurus
`

Configuration

Add the plugin to your docusaurus.config.js:

`js
const baseSettings = {
apiKey: 'YOUR_API_KEY',
}
module.exports = {
plugins: [
[
'@inkeep/cxkit-docusaurus',
{
ChatButton: {
// Props for InkeepChatButton component
baseSettings,
modalSettings: {
// Props for InkeepChatButton modal
shortcutKey: null,
},
},
SearchBar: {
// Props for InkeepSearchBar component
baseSettings,
},
},
],
],
}
``

> Adding the component key to plugin options means enabling it, removing it means disabling it.

License

Inkeep, Inc. Customer License (IICL) v1.1