https://github.com/purecloudlabs/genesys-cloud-platform-client-doc-viewer
This project displays the SDK documentation using the public-facing YEAST markdown parsing/rendering toolkit.
https://github.com/purecloudlabs/genesys-cloud-platform-client-doc-viewer
Last synced: 5 months ago
JSON representation
This project displays the SDK documentation using the public-facing YEAST markdown parsing/rendering toolkit.
- Host: GitHub
- URL: https://github.com/purecloudlabs/genesys-cloud-platform-client-doc-viewer
- Owner: purecloudlabs
- License: mit
- Created: 2024-08-13T17:30:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-02T06:34:18.000Z (7 months ago)
- Last Synced: 2026-01-08T02:21:01.741Z (7 months ago)
- Language: TypeScript
- Size: 383 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# genesys-cloud-platform-client-doc-viewer
A React app for viewing the Genesys Cloud platform client SDK documentation.
## Hosting using Github Pages
This app should be built using one of the app's package scripts, such as `npm run build:java`. The resulting app can then be hosted using Github Pages in the SDK's repo. Each SDK language's build command injects configuration variables used by the app to adjust the web paths used by the app.
### Single Page App Workaround
Github Pages doesn't have any built-in configuration that will allow a single page app to be served for unknown file paths. It does allow a custom 404 error page, however. The `404.html` file in the `public` directory will be served by Github Pages for unknown file paths. That page uses the techniques described in [rafgraph/spa-github-pages](https://github.com/rafgraph/spa-github-pages) to load the React app.