Welcome to the new DocsGPT 🦖 docs! 👋
Extensions
🏗️ Widget setup

Setting up the DocsGPT Widget in Your React Project

Introduction:

The DocsGPT Widget is a powerful tool that allows you to integrate AI-powered documentation assistance into your web applications. This guide will walk you through the installation and usage of the DocsGPT Widget in your React project. Whether you're building a web app or a knowledge base, this widget can enhance your user experience.

Installation

First, make sure you have Node.js and npm installed in your project. Then go to your project and install a new dependency: npm install docsgpt.

Usage

In the file where you want to use the widget, import it and include the CSS file:

import { DocsGPTWidget } from "docsgpt";

Now, you can use the widget in your component like this :

<DocsGPTWidget
  apiHost="https://your-docsgpt-api.com"
  selectDocs="local/docs.zip"
  apiKey=""
  avatar = "https://d3dg1063dc54p9.cloudfront.net/cute-docsgpt.png",
  title = "Get AI assistance",
  description = "DocsGPT's AI Chatbot is here to help",
  heroTitle = "Welcome to DocsGPT !",
  heroDescription="This chatbot is built with DocsGPT and utilises GenAI, 
  please review important information using sources."
/>

DocsGPTWidget takes 8 props with default fallback values:

  1. apiHost — The URL of your DocsGPT API.
  2. selectDocs — The documentation source that you want to use for your widget (e.g. default or local/docs1.zip).
  3. apiKey — Usually, it's empty.
  4. avatar: Specifies the URL of the avatar or image representing the chatbot.
  5. title: Sets the title text displayed in the chatbot interface.
  6. description: Provides a brief description of the chatbot's purpose or functionality.
  7. heroTitle: Displays a welcome title when users interact with the chatbot.
  8. heroDescription: Provide additional introductory text or information about the chatbot's capabilities.

How to use DocsGPTWidget with Nextra (opens in a new tab) (Next.js + MDX)

Install your widget as described above and then go to your pages/ folder and create a new file _app.js with the following content:

import { DocsGPTWidget } from "docsgpt";
 
export default function MyApp({ Component, pageProps }) {
    return (
        <>
            <Component {...pageProps} />
            <DocsGPTWidget selectDocs="local/docsgpt-sep.zip/"/>
        </>
    )
}

How to use DocsGPTWidget with HTML

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>DocsGPT Widget</title>
</head>
<body>
  <div id="app"></div>
  <!-- Include the widget script from dist/modern or dist/legacy -->
  <script src="https://unpkg.com/docsgpt/dist/modern/main.js" type="module"></script>
  <script type="module">
    window.onload = function() {
      renderDocsGPTWidget('app');
    }
  </script>
</body>
</html>

To link the widget to your api and your documents you can pass parameters to the renderDocsGPTWidget('div id', { parameters }).

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>DocsGPT Widget</title>
</head>
<body>
  <div id="app"></div>
  <!-- Include the widget script from dist/modern or dist/legacy -->
  <script src="https://unpkg.com/docsgpt/dist/modern/main.js" type="module"></script>
  <script type="module">
    window.onload = function() {
      renderDocsGPTWidget('app', {
        apiHost: 'http://localhost:7001',
        selectDocs: 'default',
        apiKey: '',
        avatar: 'https://d3dg1063dc54p9.cloudfront.net/cute-docsgpt.png',
        title: 'Get AI assistance',
        description: "DocsGPT's AI Chatbot is here to help",
        heroTitle: 'Welcome to DocsGPT!',
        heroDescription: 'This chatbot is built with DocsGPT and utilises GenAI, please review important information using sources.'
      });
    }
  </script>
</body>
</html>

For more information about React, refer to this link here (opens in a new tab)

💬️ Chatwoot Extension🌐 Chrome Extension
MIT 2024 © DocsGPT