Skip to content

README.md

Latest commit

 

History

History
65 lines (45 loc) · 1.93 KB

README.md

File metadata and controls

65 lines (45 loc) · 1.93 KB

docusaurus-plugin-ai-assistant

npm version License Downloads

CrawlDesk Ask AI Assistant for Docusaurus — add an interactive Ask AI assistant to your documentation effortlessly.

This plugin lazy-loads the CrawlDesk Ask AI widget for fast performance and allows simple configuration for theme, and other options.

🌐 Visit CrawlDesk to learn more or Request a Demo.

🚀 Features

  • Lazy-loaded: non-blocking widget for faster page loads
  • Theme support: dark, light, or custom
  • Secure API key injection: only your key is required
  • Seamless integration with any Docusaurus v3 site
  • Easy configuration via plugin options
  • Ask AI ready: lets users ask questions directly inside your docs

Installation

npm install --save docusaurus-plugin-ai-assistant
# or
yarn add docusaurus-plugin-ai-assistant

Usage

In your docusaurus.config.js:

module.exports = {
  plugins: [
    [
      "docusaurus-plugin-ai-assistant",
      {
        key: "YOUR_CRAWLDESK_WIDGET_KEY",
        config: {
          theme: "dark",
        },
      },
    ],
  ],
};

  • key: Your CrawlDesk Ask AI widget API key

  • config: Optional local overrides for the widget.
    Most settings are managed via the CrawlDesk Dashboard, but you can override values locally here if needed.

That’s it — the Ask AI assistant will automatically appear in your docs!

Why Use CrawlDesk Ask AI Assistant?

Make your docs smarter with an interactive Ask AI assistant

Reduce support load by letting users ask questions directly in docs

Fully managed by CrawlDesk, easy to drop into any Docusaurus site