DocNavigator is an AI-powered chatbot builder that is designed to improve the user experience on product documentation/support websites.
npm install doc-navigatorDocNavigator is an AI-powered chatbot builder that is designed to improve the user experience on product documentation/support websites. It can be trained on the data available on the company's website, making it a scalable solution for organizations of any size.
With its ability to handle multiple queries at once, DocNavigator can save customers time and boost productivity, all while improving customer satisfaction.
To use the DocNavigator, you'll need to have npm or yarn installed.
1. Install the package using npm or yarn:
``bash`
npm install doc-navigator
or
`bash`
yarn add doc-navigator
2. Import the SearchComponent in your React component:
`typescriptreact`
import { SearchComponent } from 'doc-navigator';
To use the DocNavigator, simply add SearchComponent to your React component's render method:
`typescriptreact
import React from 'react';
import { SearchComponent } from 'doc-navigator';
export const MyComponent = () => {
return (
Props
The
SearchComponent accepts the following props:-
url (string, required): The URL of the search endpoint. // Visit here for more info
- welcomeMessage (string, optional): An optional welcome message to display above the search box.
- projectId (string, required): The ID of the project to search within.
- variant ('dark' | 'light', optional): The color variant of the search component. Use 'dark' for dark mode and 'light' for light mode.
- width (string, optional): The width of the search component.
- height (string, optional): The height of the search component.
- searchComponent (React component, optional): An optional custom search component to use instead of the default one.`That's it! You should now be able to use the
SearchComponent in your React project. Feel free to raise a issue if you have any doubt.
``