mirror of https://github.com/arc53/DocsGPT
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.1 KiB
Markdown
38 lines
1.1 KiB
Markdown
### How to set up react docsGPT widget on your website:
|
|
|
|
### Installation
|
|
Got to your project and install a new dependency: `npm install docsgpt`.
|
|
|
|
### Usage
|
|
Go to your project and in the file where you want to use the widget import it:
|
|
```js
|
|
import { DocsGPTWidget } from "docsgpt";
|
|
import "docsgpt/dist/style.css";
|
|
```
|
|
|
|
|
|
Then you can use it like this: `<DocsGPTWidget />`
|
|
|
|
DocsGPTWidget takes 3 props:
|
|
- `apiHost` — url of your DocsGPT API.
|
|
- `selectDocs` — documentation that you want to use for your widget (eg. `default` or `local/docs1.zip`).
|
|
- `apiKey` — usually its empty.
|
|
|
|
### How to use DocsGPTWidget with [Nextra](https://nextra.site/) (Next.js + MDX)
|
|
Install you widget as described above and then go to your `pages/` folder and create a new file `_app.js` with the following content:
|
|
```js
|
|
import { DocsGPTWidget } from "docsgpt";
|
|
import "docsgpt/dist/style.css";
|
|
|
|
export default function MyApp({ Component, pageProps }) {
|
|
return (
|
|
<>
|
|
<Component {...pageProps} />
|
|
<DocsGPTWidget selectDocs="local/docsgpt-sep.zip/"/>
|
|
</>
|
|
)
|
|
}
|
|
```
|
|
|
|
|