mirror of https://github.com/arc53/DocsGPT
Merge pull request #333 from arc53/feature/update-guides
updated deployment and created react widget guidepull/335/head
commit
4f7fd0a62b
@ -0,0 +1,37 @@
|
|||||||
|
### 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/"/>
|
||||||
|
</>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue