Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Clean up docusaurus website #327

Merged
merged 1 commit into from
Mar 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 27 additions & 22 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,38 @@ While the math.gl is highly **optimized for use with the WebGL and WebGPU APIs**

math.gl is a toolbox that offers a suite of composable modules.

| Image | Module | Description |
| --------------------------------------------------- | ----------------------- | -------------------------------------------------- |
| **Core math libraries** | | |
| ![core](./images/core.png 'core') | `@math.gl/types` | Basic math type helpers (`NumericArray` etc) |
| ![core](./images/core.png 'core') | `@math.gl/core` | 3D math classes (vectors, matrices, etc) |
| ![culling](./images/culling.png 'culling') | `@math.gl/culling` | Bounding volumes and intersection testing. |
| **Geospatial math libraries** | | |
| ![geospatial](./images/geospatial.svg 'geospatial') | `@math.gl/geospatial` | Ellipsoidal math for WGS84 coordinates. |
| ![geoid](./images/geoid.png 'geoid') | `@math.gl/geoid` | Earth Gravity Model support . |
| | `@math.gl/polygon` | Polygon math, including geospatial cutting etc. |
| | `@math.gl/proj4` | Conversion between coordinate reference systems. |
| | `@math.gl/sun` | Solar position / direction from position and time. |
| | `@math.gl/web-mercator` | Supports 3D Web Mercator (spherical) projections. |
| **DGGS (Discrete global grid support) libraries** | | |
| ![geohash](./images/dggs/geohash.png 'geohash') | `@math.gl/geohash` | Get geometry of GeoHash tokens. |
| ![quadkey](./images/dggs/quadkey.png 'quadkey') | `@math.gl/quadkey` | Get geometry of QuadKey tokens |
| ![s2](./images/dggs/s2.png 's2') | `@math.gl/s2` | Get geometry of S2 tokens. |
| **Core math libraries** | Module <span style={{width: 300}} /> | Description |
| --------------------------------------------------- | ------------------------------------ | -------------------------------------------------- |
| | | |
| | **`@math.gl/types`** | Basic math type helpers (`NumericArray` etc) |
| ![core](./images/core.png 'core') | **`@math.gl/core`** | 3D math classes (vectors, matrices, etc) |
| ![culling](./images/culling.png 'culling') | **`@math.gl/culling`** | Bounding volumes and intersection testing. |

| **Geospatial math libraries** | Module <span style={{width: 300}} /> | Description |
| --------------------------------------------------- | --------------------------- | -------------------------------------------------- |
| ![geospatial](./images/geospatial.svg 'geospatial') | **`@math.gl/geospatial`** | Ellipsoidal math for WGS84 coordinates. |
| ![geoid](./images/geoid.png 'geoid') | **`@math.gl/geoid`** | Earth Gravity Model support . |
| | **`@math.gl/polygon`** | Polygon math, including geospatial cutting etc. |
| | **`@math.gl/proj4`** | Conversion between coordinate reference systems. |
| | **`@math.gl/sun`** | Solar position / direction from position and time. |
| | **`@math.gl/web-mercator`** | Supports 3D Web Mercator (spherical) projections. |

| **DGGS (Discrete global grid support) libraries** | Module <span style={{width: 300}} /> | Description |
| --------------------------------------------------- | --------------------------- | -------------------------------------------------- |
| | | |
| ![geohash](./images/dggs/geohash.png 'geohash') | **`@math.gl/geohash`** | Get geometry of GeoHash tokens. |
| ![quadkey](./images/dggs/quadkey.png 'quadkey') | **`@math.gl/quadkey`** | Get geometry of QuadKey tokens |
| ![s2](./images/dggs/s2.png 's2') | **`@math.gl/s2`** | Get geometry of S2 tokens. |

<br/>
In addition, math.gl provides a few deprecated legacy modules, to avoid breaking older applications.
<br/>
<br/>

| Legacy Module | Description |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `math.gl` | Re-exports the API from `@math.gl/core`. An "alias" for `@math.gl/core` to avoid breaking old applications. |
| `viewport-mercator-project` | Re-exports the Web Mercator projection utilities in `@math.gl/web-mercator`. The [viewport-mercator-project](https://github.com/uber-common/viewport-mercator-project) repository was moved to math.gl in Oct 2019. |
| Legacy Module | Description |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`math.gl`** | Re-exports the API from **`@math.gl/core`**. An "alias" for **`@math.gl/core`** to avoid breaking old applications. |
| **`viewport-mercator-project`** | Re-exports the Web Mercator projection utilities in **`@math.gl/web-mercator`**. The [viewport-mercator-project](https://github.com/uber-common/viewport-mercator-project) repository was moved to math.gl in Oct 2019. |

## Supported Browsers and Node Versions

Expand Down Expand Up @@ -63,7 +68,7 @@ math.gl was inspired by and built upon some of the most proven open source JavaS

## License

MIT license. The libraries that the core `math.gl` module are built on (e.g. gl-matrix) are also all open source and MIT licensed.
MIT license. The libraries that the core `@math.gl/core` module are built on (e.g. gl-matrix) are also all open source and MIT licensed.

The `@math.gl/geospatial` and `@math.gl/culling` modules include Cesium-derived code which is Apache2 licensed.

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/core/api-reference/matrix.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Matrix

`Matrix` is a base class for [`Matrix3`](./docs/api-reference/vector3) and [`Matrix4`](./docs/api-reference/vector4), providing common methods to those classes.
`Matrix` is a base class for [`Matrix3`](./docs/modules/core/api-reference/vector3) and [`Matrix4`](./docs/modules/core/api-reference/vector4), providing common methods to those classes.

## Methods

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/core/api-reference/matrix3.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const vector3 = transform.transformDirection([1, 2, 1]);

## Methods

Many of the most commonly used methods are inherited from [`MathArray`](./docs/api-reference/math-array.md):
Many of the most commonly used methods are inherited from [`MathArray`](./math-array.md):

- `matrix3.clone()`
- `matrix3.copy(array)`
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/core/api-reference/matrix4.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ const vector4 = transform.transformDirection([0, 1, 2, 1]);

## Inheritance

`class Matrix4 extends` [`Matrix`](/modules/core/docs/api-reference/matrix) `extends` [`MathArray`](modules/core/docs/api-reference/math-array) `extends` [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)`
`class Matrix4 extends` [`Matrix`](/docs/modules/core/api-reference/matrix) `extends` [`MathArray`](/docs/modules/core/api-reference/math-array) `extends` [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)`

Many basic methods are inherited:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/core/api-reference/quaternion.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Gets or sets element 0, 1, 2 or 3 respectively

## Methods

Many of the most commonly used methods are inherited from [`MathArray`](./docs/api-reference/math-array.md):
Many of the most commonly used methods are inherited from [`MathArray`](./math-array.md):

- `quaternion.clone()`
- `quaternion.copy(array)`
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/core/api-reference/vector.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vector

`Vector` is a base class for [`Vector2`](./docs/api-reference/vector2), [`Vector3`](./docs/api-reference/vector3) and [`Vector4`](./docs/api-reference/vector4), providing common methods to those classes.
`Vector` is a base class for [`Vector2`](/docs/modules/core/api-reference/vector2), [`Vector3`](/docs/modules/core/api-reference/vector3) and [`Vector4`](/docs/modules/core/api-reference/vector4), providing common methods to those classes.

## Inheritance

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/core/api-reference/vector2.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const vector = new Vector2(1, 1);

## Inheritance

`Vector2` extends [`Vector`](./docs/api-reference/vector) extends [`MathArray`](./docs/api-reference/math-array) extends [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
`Vector2` extends [`Vector`](/docs/modules/core/api-reference/vector) extends [`MathArray`](/docs/modules/core/api-reference/math-array) extends [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)

Many commonly used `Vector2` methods are inherited from `Vector` and `MathArray`:

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/core/api-reference/vector3.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const w = v.scale([1, -1, 1]); // Flip y component

## Inheritance

`Vector3` extends [`Vector`](./docs/api-reference/vector) extends [`MathArray`](./docs/api-reference/math-array) extends [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
`Vector3` extends [`Vector`](/docs/modules/core/api-reference/vector) extends [`MathArray`](/docs/modules/core/api-reference/math-array) extends [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)

## Members

Expand All @@ -51,7 +51,7 @@ Gets or sets element 0, 1 or 2 respectively

## Methods

Many of the most commonly used `Vector3` methods are inherited from [`MathArray`](./docs/api-reference/math-array.md):
Many of the most commonly used `Vector3` methods are inherited from [`MathArray`](./math-array.md):

- `Vector3.clone()`
- `Vector3.copy(array)`
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/core/api-reference/vector4.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const point = new Vector4(0, 0, 0, 1);

## Inheritance

`Vector4` extends [`Vector`](./docs/api-reference/vector) extends [`MathArray`](./docs/api-reference/math-array) extends [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
`Vector4` extends [`Vector`](./vector) extends [`MathArray`](./math-array) extends [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)

## Members

Expand All @@ -33,7 +33,7 @@ Gets or sets element 0, 1, 2 or 3 respectively

## Methods

Many of the most commonly used `Vector2` methods are inherited from [`MathArray`](./docs/api-reference/math-array.md):
Many of the most commonly used `Vector2` methods are inherited from [`MathArray`](./math-array):

- `Vector4.clone()`
- `Vector4.copy(array)`
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/core/concepts/coordinate-systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ math.gl provides support for a couple of 3D coordinate systems:

- Rectilinear (`Vector3`) - Typically used to represent standard Cartesian space
- Spherical (`SpericalCoordinates`) - Two angles representing point on sphere and a distance from center
- Projective/Homogeneous (`Vector4`) - These are coordinates in "projective" 3-space. The purpose of these is explained in [link](./'homogeneous-coordinates.md')
- Projective/Homogeneous (`Vector4`) - These are coordinates in "projective" 3-space. The purpose of these is explained in [link](./homogeneous-coordinates)

## Converting between Coordinate Systems

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const box = makeAxisAlignedBoundingBoxFromPoints([

## Inheritance

`class AxisAlignedBoundingBox implements` [`BoundingVolume`](/modules/culling/docs/api-reference/bounding-volume).
`class AxisAlignedBoundingBox implements` [`BoundingVolume`](./bounding-volume).

## Global Functions

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/culling/api-reference/bounding-sphere.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ spheres.sort(

## Inheritance

`class BoundingSphere implements` [`BoundingVolume`](/modules/culling/docs/api-reference/bounding-volume).
`class BoundingSphere implements` [`BoundingVolume`](./bounding-volume).

## Global Functions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const box = makeOrientedBoundingBoxFromPoints([

## Inheritance

`class OrientedBoundingBox implements` [`BoundingVolume`](/modules/culling/docs/api-reference/bounding-volume).
`class OrientedBoundingBox implements` [`BoundingVolume`](./bounding-volume).

## Global Functions

Expand Down
5 changes: 5 additions & 0 deletions docs/modules/geohash/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Overview

<p class="badges">
<img src="https://img.shields.io/badge/From-v3.7-blue.svg?style=flat-square" alt="From-v3.7" />
</p>


`@math.gl/geohash` is a JavaScript library with

## Installation
Expand Down
6 changes: 5 additions & 1 deletion docs/modules/geohash/api-reference/geohash.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# geohash
# GeoHash API

<p class="badges">
<img src="https://img.shields.io/badge/From-v3.7-blue.svg?style=flat-square" alt="From-v3.7" />
</p>

> TBA
4 changes: 4 additions & 0 deletions docs/modules/quadkey/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Overview

<p class="badges">
<img src="https://img.shields.io/badge/From-v3.7-blue.svg?style=flat-square" alt="From-v3.7" />
</p>

`@math.gl/quadkey` is a JavaScript library providing math for the Quadkey DGGS (Discrete Global Grid System).

## Installation
Expand Down
7 changes: 6 additions & 1 deletion docs/modules/quadkey/api-reference/quadkey.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# quadkey
# QuadKey API

<p class="badges">
<img src="https://img.shields.io/badge/From-v3.7-blue.svg?style=flat-square" alt="From-v3.7" />
</p>


> TBA
4 changes: 4 additions & 0 deletions docs/modules/s2/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Overview

<p class="badges">
<img src="https://img.shields.io/badge/From-v3.7-blue.svg?style=flat-square" alt="From-v3.7" />
</p>

`@math.gl/s2` is a small JavaScript library for working with the S2 DGGS (Discrete Global Grid System).

## Installation
Expand Down
6 changes: 5 additions & 1 deletion docs/modules/s2/api-reference/s2.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# S2
# S2 API

<p class="badges">
<img src="https://img.shields.io/badge/From-v3.7-blue.svg?style=flat-square" alt="From-v3.7" />
</p>

See [s2geometry.io](https://s2geometry.io/) for more information.

Expand Down
2 changes: 1 addition & 1 deletion docs/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ Release date: April 16, 2018

### Matrix4 Improvements

**`Matrix4.orthographic()`** - To simplify switching between perspective and orthographic views, math.gl now offers an additional method for creating orthographic projection matrix, that takes the same parameters as `Matrix4.perspective()`, with the addition of one additional parameter, `focalDistance`. See [`Matrix4.orthographic`](docs/api-reference/matrix4)`({fovy, aspect, focalDistance, near, far})`
**`Matrix4.orthographic()`** - To simplify switching between perspective and orthographic views, math.gl now offers an additional method for creating orthographic projection matrix, that takes the same parameters as `Matrix4.perspective()`, with the addition of one additional parameter, `focalDistance`. See [`Matrix4.orthographic`](/docs/modules/core/api-reference/matrix4)`({fovy, aspect, focalDistance, near, far})`

### Bundle Size Reduction

Expand Down
2 changes: 0 additions & 2 deletions website-gatsby/.eslintignore

This file was deleted.

59 changes: 0 additions & 59 deletions website-gatsby/.gitignore

This file was deleted.

Loading