Crawldesk Ask AI Widget Deployment
The CrawlDesk Ask AI widget enhances your documentation or support portal by adding an interactive AI-powered assistant that enables users to ask natural language questions directly within your site, improving user experience and engagement. The widget is integrated via a lightweight script embed, hosted at Crawldesk CDN.
This industry-grade guide provides a concise overview of deploying the CrawlDesk Ask AI widget across multiple platforms, including Docusaurus, Mintlify, Freshdesk, GitBook, Framer, Nextra, and Zendesk Help Center, using the script embed method. Each platform has tailored integration steps, ensuring seamless deployment and robust performance.
Prerequisites (All Platforms):
- Active CrawlDesk account
- Administrative access to your platform’s code editor or admin panel for adding custom scripts.
- CrawlDesk widget API key (obtained from the CrawlDesk dashboard).
Supported Platform
| Platform | Deployment Method | Documentation Link |
|---|---|---|
| Docusaurus | Add the widget script to docusaurus.config.js in the scripts array, then rebuild your site. | Docusaurus Deployment Guide |
| Mintlify | Create a JavaScript file (e.g., crawldesk-widget.js) in the docs directory with the widget script and publish changes. | Mintlify Deployment Guide |
| Freshdesk | Add the widget script to the Footer section in Admin panel under Portals > Settings > Edit Portal > Custom Scripts, then publish. | Freshdesk Deployment Guide |
| GitBook | Embed the widget script using an Embed block or custom code integration in the GitBook editor, then publish changes. | GitBook Deployment Guide |
| Framer | Add the widget script via Custom Code or Head Code Injection in Framer Settings, then publish the site. | Framer Deployment Guide |
| Nextra | Add the widget script to the appropriate configuration file (e.g., layout or theme config), then rebuild your site. | Nextra Deployment Guide |
| Zendesk Help Center | Add the widget script to the theme’s head section in Guide Admin > Customize design > Edit Code, then save and publish. | Zendesk Help Center Deployment Guide |
If you cannot find the documentation for your platform listed here or have specific custom deployment needs, please reach out to CrawlDesk support at contact@crawldesk.com for assistance.
Best Practices
- Secure the API Key: Manage your CrawlDesk API key securely in the CrawlDesk dashboard. Avoid hardcoding sensitive information in client-side scripts and follow each platform’s security guidelines to protect your key.
- Customization: Use the CrawlDesk dashboard to configure widget settings, such as colors, logos, and styling, to align with your brand identity for a consistent user experience.
- Testing and Validation: After embedding the script, thoroughly test the widget across your site to ensure functionality. Verify compatibility with your platform’s layout and user flows.
- Deployment: Always rebuild or publish your site after adding the script to ensure changes take effect. Check for errors in the browser console or platform logs during deployment.
- Maintenance: Regularly update your CrawlDesk project with new knowledge sources and monitor widget performance via the CrawlDesk dashboard to maintain accuracy and relevance.
Custom Deployment Support
If your platform not listed here where you want to deploy the CrawlDesk Ask AI widget, our team can provide tailored integration support. Contact CrawlDesk support at contact@crawldesk.com for assistance with custom deployments.