https://github.com/botpress/documentation-v12
Botpress official documentation
https://github.com/botpress/documentation-v12
Last synced: 8 months ago
JSON representation
Botpress official documentation
- Host: GitHub
- URL: https://github.com/botpress/documentation-v12
- Owner: botpress
- Created: 2021-12-15T21:34:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-07T18:01:45.000Z (over 3 years ago)
- Last Synced: 2025-04-06T09:43:18.841Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://botpress.com/docs
- Size: 52.1 MB
- Stars: 4
- Watchers: 10
- Forks: 26
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
#### About search
In order to play aroud with search locally you need to set algolia env variables by default set to "empty"
`export ALGOLIA_API_KEY =__YOUR_ALGOLIA_API_KEY__`
`export ALGOLIA_APP_ID =__YOUR_ALGOLIA_APP_ID__`
`export ALGOLIA_INDEX =__YOUR_ALGOLIA_INDEX__`
A temporary solution has been done since we redirect everything from /docs/ to this documetation site. Whenever we remove this redirect we should remove the `customWithBaseUrl` function in the `src/theme/SearchBar/index.tsx` and use the native `withBaseUrl` instead.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Deployement is handled by Vercel