Skip to content

Commit 4e9fc59

Browse files
authored
docs: add sandbox to GitHub pages (#11)
* docs: add sandbox to GitHub pages * chore(deps): update @BabylonJS version in peerDependencies
1 parent 1721eae commit 4e9fc59

File tree

11 files changed

+180
-192
lines changed

11 files changed

+180
-192
lines changed

.github/workflows/docs-publish.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,16 @@ jobs:
5353
- name: Build docs
5454
run: npm run docs
5555

56+
- name: Run webpack
57+
run: npm run webpack
58+
59+
- name: Create .nojekyll file
60+
run: touch web/.nojekyll
61+
5662
- name: Upload static files as artifact
5763
uses: actions/upload-pages-artifact@v3
5864
with:
59-
path: docs/
65+
path: web/
6066

6167
deploy:
6268
needs: build

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ dist
77
.idea
88
coverage
99
*.tgz
10-
docs
10+
docs
11+
web

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
55

66
**lib-3d-scene-viewer** is a package based on [Babylon.js](https://www.babylonjs.com/).
7-
It provides preset configurations for quickly setting up a 3D scene viewer.
7+
It provides preset configurations for quickly setting up a 3D scene viewer,
8+
which offers a 3D environment similar to the "View in 3D" CX on Amazon Product Detail Pages.
89

910

1011
## Table of Contents
@@ -14,6 +15,7 @@ It provides preset configurations for quickly setting up a 3D scene viewer.
1415
- [Usage](#usage)
1516
- [Resource](#resource)
1617
- [Config](#config)
18+
- [Sandbox](#sandbox)
1719
- [Documentation](#documentation)
1820
- [Development](#development)
1921
- [Contributing](#contributing)
@@ -182,9 +184,14 @@ It also provides preset config files in [preset](src/config/preset) folder
182184
or `@amazon/lib-3d-scene-viewer/config/preset`.
183185

184186

187+
## Sandbox
188+
189+
Try loading GLB/GLTF models into the [Sandbox](https://amzn.github.io/lib-3d-scene-viewer/v3dViewer.html).
190+
191+
185192
## Documentation
186193

187-
- [API Docs](https://amzn.github.io/lib-3d-scene-viewer)
194+
- [API Docs](https://amzn.github.io/lib-3d-scene-viewer/docs/index.html)
188195

189196

190197
## Development

0 commit comments

Comments
 (0)