Vetradocs Docusaurus Plugin

AI-powered documentation chat for Docusaurus.

Installation

npm install vetradocs-docusaurus

Usage

1. Add the plugin components to your theme:

   You need to wrap your site with the VetradocsChat and VetradocsFloatingBar components. The easiest way is to Swizzle the Layout or Root.

   e.g. src/theme/Root.js:

   import React from 'react';
   import { VetradocsChat, VetradocsFloatingBar } from 'vetradocs-docusaurus';
   import 'vetradocs-docusaurus/dist/theme/VetradocsChat/styles.css';
   import 'vetradocs-docusaurus/dist/theme/VetradocsFloatingBar/styles.css';
   
   export default function Root({children}) {
     return (
       <>
         {children}
         <VetradocsFloatingBar />
         <VetradocsChat />
       </>
     );
   }

2. Generate the Search Index:

   Add a script to your package.json to build the index after your docs are built.

   "scripts": {
     "build": "docusaurus build && npx vetradocs-build-docusaurus"
   }

   This will generate static/search-index.json.

Configuration

Pass props to the components to configure them.

<VetradocsFloatingBar 
    apiEndpoint="/api/your-chat-endpoint" 
    title="My AI Docs" 
    accentColor="#fa5252" 
/>
<VetradocsChat 
    apiEndpoint="/api/your-chat-endpoint"
/>