@deskcrew/docusaurus-plugin

@deskcrew/docusaurus-plugin

Add AI live chat, a help center and ticketing to any Docusaurus site in about two minutes, free, with no credit card. @deskcrew/docusaurus-plugin is the official DeskCrew plugin: one entry in docusaurus.config.js puts a support widget on every docs page, answers reader questions from your own help articles, and turns anything it cannot answer into a real support ticket.

Documentation sites get the most out of this: readers who cannot find an answer in the docs usually leave. The widget catches that moment, answers from your knowledge base, and files a ticket when it cannot.

Install

npm install @deskcrew/docusaurus-plugin

// docusaurus.config.js
module.exports = {
  plugins: [
    [
      '@deskcrew/docusaurus-plugin',
      {
        widgetKey: 'pub_xxxxxxxx', // required, from Dashboard → Install
        // board: 'your-workspace', // optional
        // color: '#4f46e5',        // optional accent colour
        // position: 'right',       // optional: 'left' | 'right'
        // greeting: 'Hi! How can we help?', // optional
      },
    ],
  ],
}

Start or build your site and the chat launcher appears on every page. No account yet? Create one free, then copy your key from Dashboard → Install.

What you get

• AI answers grounded in your own help articles. The assistant only answers from the knowledge base you publish, so it cannot invent product facts.
• A human approves before anything sends. Every AI draft waits in an approval queue. Nothing reaches a reader unreviewed.
• Every conversation becomes a ticket. Widget chats, emails and board posts land in one dashboard with full history.
• Readers who leave still get answered. Leave an email address and the reply arrives by email.
• Free plan, no card. Chat widget, public knowledge base and ticketing are included on the free plan.

Options

Option	Type	Required	Description
widgetKey	string	yes	Your public key (pub_…).
board	string	no	Board slug (lowercase letters, numbers, dashes).
color	string	no	Accent colour as a 6-digit hex value, e.g. #4f46e5.
position	'left' | 'right'	no	Which side the launcher sits on.
greeting	string	no	Greeting shown on the launcher.

If widgetKey is missing or malformed the plugin prints a build-time warning and adds nothing. Your site still builds.

How it works

The plugin appends a single <script src="https://deskcrew.io/desk.js"> tag to every page via the injectHtmlTags lifecycle (postBodyTags). The widget renders inside a Shadow DOM, so it cannot inherit or leak your theme's CSS. desk.js reads your settings from its data-* attributes and derives its API origin from its own src, so there is nothing else to configure.

Docusaurus compatibility: works with Docusaurus 2 and later, including v3, with both the classic preset and custom themes.

How it compares

	DeskCrew	Intercom	Crisp	Tidio
Free plan with AI answers	Yes	No	Limited	Limited
Human approves AI replies	Yes, built in	No	No	No
Official Docusaurus plugin	Yes	No	No	No
Public knowledge base included	Yes	Paid add-on	Paid tier	Paid tier
Credit card to start	No	Yes	No	No

FAQ

How do I add live chat to a Docusaurus site?

Install @deskcrew/docusaurus-plugin, add it to plugins in docusaurus.config.js with your public widget key, and restart. The launcher appears on every page.

Is it free?

Yes. The free plan includes the chat widget, a public knowledge base and ticketing, with no credit card. Paid plans add higher AI allowances and team features. See pricing.

Does it work with Docusaurus v3?

Yes. It supports Docusaurus 2 and later, with the classic preset or a custom theme.

Will it clash with my theme or dark mode?

No. The widget renders in a Shadow DOM, so your theme's CSS cannot leak into it and it cannot restyle your site.

Does the AI answer from my docs?

It answers from the knowledge base you publish in DeskCrew. When it has no grounded answer it escalates to a human instead of guessing, and every draft reply requires human approval before sending.

Does it slow the docs down?

The plugin adds one deferred script tag. Nothing renders until the reader opens the launcher.

Links

• Docusaurus integration page: https://deskcrew.io/integrations/docusaurus
• All integrations: https://deskcrew.io/integrations
• Pricing: https://deskcrew.io/pricing
• Start free: https://deskcrew.io/signup

License

MIT DeskCrew · deskcrew.io · hello@deskcrew.io

Updated July 2026.