What is Docusaurus

Docusaurus is an open-source documentation platform powered by MDX and React.

Install the Inkeep plugin

  • npm

  • bun

  • pnpm

  • yarn

npm install @inkeep/docusaurus

Configure the widget

Аdd the Inkeep widgets as themes in the docusaurus.config.js file:

docusaurus.config.js
themes: ["@inkeep/docusaurus/chatButton", "@inkeep/docusaurus/searchBar"],

Сonfiguration settings

Next, configure the widgets in the themeConfig property:

docusaurus.config.js
  //..
  themeConfig: {
    inkeepConfig: {
      baseSettings: {
        apiKey: "YOUR_API_KEY", // required
        integrationId: "YOUR_INTEGRATION_ID", // required
        organizationId: "YOUR_ORGANIZATION_ID", // required
        primaryBrandColor: "#26D6FF", // required -- your brand color, the widget color scheme is derived from this
        organizationDisplayName: "Inkeep",
        // ...optional settings
        theme: {
          syntaxHighlighter: {
            lightTheme: lightCodeTheme, // optional -- pass in the prism theme you're using
            darkTheme: darkCodeTheme, // optional -- pass in the prism theme you're using
          },
        }
      },
      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?",
        ],
      },
    },
  },

For a full list of customizations, check out the Common Settings.

FAQ