Skip to content

Commit

Permalink
Rewritten website (#295)
Browse files Browse the repository at this point in the history
* New Website

* Fix kepler example in website

* Add website action

* What's new
  • Loading branch information
chrisgervang authored Feb 4, 2025
1 parent e65f573 commit 19e4303
Show file tree
Hide file tree
Showing 47 changed files with 8,014 additions and 15,544 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: website

on:
push:
branches:
- '*-release'

jobs:
check_branch:
runs-on: ubuntu-22.04
outputs:
should_deploy: ${{ endsWith(github.ref, steps.get_version.outputs.latest) }}

steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Get version
id: get_version
run: |
LATEST=$(npm show hubble.gl version | grep -o -E "^[0-9]+\.[0-9]+")
echo "latest=${LATEST}-release" >> "$GITHUB_OUTPUT"
deploy:
runs-on: ubuntu-22.04
needs: check_branch

permissions:
contents: write

if: ${{ github.repository_owner == 'visgl' && needs.check_branch.outputs.should_deploy }}

steps:
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
token: ${{ secrets.WEBSITE_DEPLOY_TOKEN }}

- name: Use Node.js
uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
with:
node-version: '18.x'

- name: Install dependencies
run: |
yarn bootstrap
(cd website && yarn)
- name: Build website
env:
MapboxAccessToken: ${{ secrets.MAPBOX_ACCESS_TOKEN }}
run: (cd website && yarn build)

- name: Deploy
uses: JamesIves/github-pages-deploy-action@132898c54c57c7cc6b80eb3a89968de8fc283505 # 3.7.1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: website/build
CLEAN: true
12 changes: 0 additions & 12 deletions docs/api-reference/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/api-reference/animations/animation-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ Draws the current frame for all attached animations.

## Source

[modules/core/src/animations/animation-manager.js](https://github.com/uber/hubble.gl/blob/master/modules/core/src/animations/animation-manager.js)
[modules/core/src/animations/animation-manager.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/animations/animation-manager.ts)
2 changes: 1 addition & 1 deletion docs/api-reference/deck-adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@ Parameters:

## Source

[modules/main/src/adapters/deck-adapter.js](https://github.com/uber/hubble.gl/blob/master/modules/main/src/adapters/deck-adapter.js)
[modules/core/src/adapters/deck-adapter.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/adapters/deck-adapter.ts)
2 changes: 1 addition & 1 deletion docs/api-reference/encoder/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Encoders
# Encoders Overview

Encoders are used to capture image frames of an HTML `<canvas/>` and encode them into videos. Each instance of an encoder represents a file artifact. During capture, they provide asynchronous functions for adding frames and saving videos. See [DeckAdapter.render](/docs/api-reference/deck-adapter#renderen) for usage.

Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/encoder/frame-encoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Returns:

* `Promise<void>` - Add is an async function. The promise will resolve when the frame capture is complete.

##### save(): Promise<Blob | ArrayBuffer>
##### save(): `Promise<Blob | ArrayBuffer>`

Compile a video of the captured frames.

Expand All @@ -95,4 +95,4 @@ Returns:

## Source

[modules/core/src/encoders/frame-encoder.js](https://github.com/uber/hubble.gl/blob/master/modules/core/src/encoders/frame-encoder.js)
[modules/core/src/encoders/frame-encoder.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/encoders/frame-encoder.ts)
2 changes: 1 addition & 1 deletion docs/api-reference/encoder/gif-encoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ In addition to the top level [FrameEncoder](/docs/api-reference/encoder/frame-en

## Source

[modules/core/src/encoders/video/gif-encoder.js](https://github.com/uber/hubble.gl/blob/master/modules/core/src/encoders/video/gif-encoder.js)
[modules/core/src/encoders/video/gif-encoder.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/encoders/video/gif-encoder.ts)

### Attributions

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/encoder/jpeg-sequence-encoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ In addition to the [FrameEncoder](/docs/api-reference/encoder/frame-encoder) set

## Source

[modules/core/src/encoders/video/jpeg-sequence-encoder.js](https://github.com/uber/hubble.gl/blob/master/modules/core/src/encoders/video/jpeg-sequence-encoder.js)
[modules/core/src/encoders/video/jpeg-sequence-encoder.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/encoders/video/jpeg-sequence-encoder.ts)
2 changes: 1 addition & 1 deletion docs/api-reference/encoder/png-sequence-encoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ ffmpeg -pattern_type glob -framerate 30 -pix_fmt yuv420p -i "*.png" -tune animat

## Source

[modules/core/src/encoders/video/png-sequence-encoder.js](https://github.com/uber/hubble.gl/blob/master/modules/core/src/encoders/video/png-sequence-encoder.js)
[modules/core/src/encoders/video/png-sequence-encoder.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/encoders/video/png-sequence-encoder.ts)
2 changes: 1 addition & 1 deletion docs/api-reference/encoder/preview-encoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ adapter.render({Encoder: PreviewEncoder});

## Source

[modules/core/src/encoders/utils/preview-encoder.js](https://github.com/uber/hubble.gl/blob/master/modules/core/src/encoders/utils/preview-encoder.js)
[modules/core/src/encoders/utils/preview-encoder.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/encoders/utils/preview-encoder.ts)
2 changes: 1 addition & 1 deletion docs/api-reference/encoder/webm-encoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ In addition to the top level [FrameEncoder](/docs/api-reference/encoder/frame-en

## Source

[modules/core/src/encoders/video/webm-encoder.js](https://github.com/uber/hubble.gl/blob/master/modules/core/src/encoders/video/webm-encoder.js)
[modules/core/src/encoders/video/webm-encoder.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/encoders/video/webm-encoder.ts)

### Attributions

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/keyframe/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Keyframes
# Keyframes Overview

[Keyframe](https://en.wikipedia.org/wiki/Key_frame) animation defines tweens and transitions given a set time-positioned values.
Keyframes interpolated between these values over the course of your animation. Hubble.gl keyframes use luma.gl's keyframe engine. See [luma.gl Keyframes](https://luma.gl/docs/api-reference/engine/animation/key-frames) for more information. `Keyframes` objects should be constructed for each object being animated, such as each deck.gl `Viewport` or `Layer`.
Expand Down
4 changes: 4 additions & 0 deletions docs/api-reference/keyframe/camera-keyframes.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ Parameters:
## More Info

See hubble.gl Keyframes and [luma.gl Keyframes](https://luma.gl/docs/api-reference/engine/animation/key-frames) for more information.

## Source

[modules/core/src/keyframes/camera-keyframes.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/keyframes/camera-keyframes.ts)
4 changes: 4 additions & 0 deletions docs/api-reference/keyframe/deck-layer-keyframes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,7 @@ Parameters:
## More Info

See hubble.gl Keyframes and [luma.gl Keyframes](https://luma.gl/docs/api-reference/engine/animation/key-frames) for more information.

## Source

[modules/core/src/keyframes/deck-layer-keyframes.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/keyframes/deck-layer-keyframes.ts)
6 changes: 5 additions & 1 deletion docs/api-reference/keyframe/keyframes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Keyframes
# Keyframes (Class)

The Keyframes class extends the luma.gl [Keyframes](https://luma.gl/docs/api-reference/engine/animation/key-frames) class and adds additional features. In your application, extend from hubble.gl's Keyframes as shown in the `CameraKeyFrames` example. Add `features` to animate, such as `latitude`. When designing your animation, keyframe values are required for each feature you define.

Expand Down Expand Up @@ -59,3 +59,7 @@ Returns:
## More Info

See [luma.gl Keyframes](https://luma.gl/docs/api-reference/engine/animation/key-frames) for more information.

## Source

[modules/core/src/keyframes/keyframes.ts](https://github.com/visgl/hubble.gl/blob/master/modules/core/src/keyframes/keyframes.ts)
148 changes: 60 additions & 88 deletions docs/table-of-contents.json
Original file line number Diff line number Diff line change
@@ -1,88 +1,60 @@
{
"id": "table-of-contents",
"chapters": [
{
"title": "Overview",
"entries": [
{
"entry": "docs"
},
{
"entry": "docs/whats-new"
}
]
},
{
"title": "Guide Book",
"entries": [
{
"entry": "docs/convert-video"
},
{
"entry": "docs/post-processing"
}
]
},
{
"title": "@hubble.gl/core",
"chapters": [
{
"title": "Adapter",
"entries": [
{
"entry": "docs/api-reference/deck-adapter"
}
]
},
{
"title": "Animations",
"entries": [
{
"entry": "docs/api-reference/animations/animation-manager"
}
]
},
{
"title": "Keyframes",
"entries": [
{
"entry": "docs/api-reference/keyframe"
},
{
"entry": "docs/api-reference/keyframe/keyframes"
},
{
"entry": "docs/api-reference/keyframe/camera-keyframes"
},
{
"entry": "docs/api-reference/keyframe/deck-layer-keyframes"
}
]
},
{
"title": "Encoders",
"entries": [
{
"entry": "docs/api-reference/encoder"
},
{
"entry": "docs/api-reference/encoder/frame-encoder"
},
{
"entry": "docs/api-reference/encoder/webm-encoder"
},
{
"entry": "docs/api-reference/encoder/gif-encoder"
},
{
"entry": "docs/api-reference/encoder/jpeg-sequence-encoder"
},
{
"entry": "docs/api-reference/encoder/png-sequence-encoder"
}
]
}
]
}
]
}
[
{
"type": "category",
"label": "Overview",
"items": [
"README",
"whats-new"
]
},
{
"type": "category",
"label": "Guide Book",
"items": [
"convert-video",
"post-processing"
]
},
{
"type": "category",
"label": "API Reference",
"items": [
{
"type": "category",
"label": "Adapters",
"items": [
"api-reference/deck-adapter"
]
},
{
"type": "category",
"label": "Animations",
"items": [
"api-reference/animations/animation-manager"
]
},
{
"type": "category",
"label": "Keyframes",
"items": [
"api-reference/keyframe/README",
"api-reference/keyframe/keyframes",
"api-reference/keyframe/camera-keyframes",
"api-reference/keyframe/deck-layer-keyframes"
]
},
{
"type": "category",
"label": "Encoders",
"items": [
"api-reference/encoder/README",
"api-reference/encoder/frame-encoder",
"api-reference/encoder/webm-encoder",
"api-reference/encoder/gif-encoder",
"api-reference/encoder/jpeg-sequence-encoder",
"api-reference/encoder/png-sequence-encoder"
]
}
]
}
]
Loading

0 comments on commit 19e4303

Please sign in to comment.