Skip to content

Commit

Permalink
chore: Upgrade docusaurus (#9281)
Browse files Browse the repository at this point in the history
  • Loading branch information
felixpalmer authored Dec 9, 2024
1 parent 48b19ab commit f9ae785
Show file tree
Hide file tree
Showing 9 changed files with 11,801 additions and 15,170 deletions.
2 changes: 1 addition & 1 deletion docs/api-reference/core/deck.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Controls the resolution of drawing buffer used for rendering.

Note:

* Consider setting to `false` or to a number <=1 if better rendering performance is needed.
* Consider setting to `false` or to a number `<=1` if better rendering performance is needed.
* When it is set to a high Number (like, 4 or more), it is possible to hit the system limit for allocating drawing buffer, such cases will log a warning and fallback to system allowed resolution.

#### `parameters` (object) {#parameters}
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/layers/bitmap-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,9 @@ The color to tint the bitmap by, in `[r, g, b]`. Each component is in the `[0, 2
The [picking info](../../developer-guide/interactivity.md#the-pickinginfo-object) passed to callbacks (`onHover`, `onClick`, etc.) provides information on which pixel was picked. It contains an additional `bitmap` field if applicable:

- `bitmap`
+ `pixel` ([x: number, y: number]) Integer coordinates into the bitmap
+ `size` ({width: number; height: number}) Size of bitmap in pixels
+ `uv` ([u: number, v: number]) Normalized (0-1) floating point coordinates
+ `pixel` (`[x: number, y: number]`) Integer coordinates into the bitmap
+ `size` (`{width: number; height: number}`) Size of bitmap in pixels
+ `uv` (`[u: number, v: number]`) Normalized (0-1) floating point coordinates

Note that the `bitmap` field can be `null` if on mouse leave or if the bitmap has not yet loaded.

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/animations-and-transitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Transitions are performed when setting `Deck`'s `viewState` or `initialViewState

* `transitionDuration` (number | string, optional, default: 0) - Transition duration in milliseconds, default value 0, implies no transition.
When using `FlyToInterpolator`, it can also be set to `'auto'` where actual duration is calculated based on the distance between the start and end states, and the `speed` option.
* `transitionEasing` (Function, optional, default: `t => t`) - Easing function that can be used to achieve effects like "Ease-In-Cubic", "Ease-Out-Cubic", etc. Default value performs Linear easing. (list of sample easing functions: <http://easings.net/>)
* `transitionEasing` (Function, optional, default: `t => t`) - Easing function that can be used to achieve effects like "Ease-In-Cubic", "Ease-Out-Cubic", etc. Default value performs Linear easing. ([list of sample easing functions](http://easings.net))
* `transitionInterruption` (number, optional, default: `TRANSITION_EVENTS.BREAK`) - This field controls how to process a new view state change that occurs while performing an existing transition. This field has no impact once transition is complete. Here is the list of all possible values with resulting behavior.

| `TRANSITION_EVENTS` | Result |
Expand Down
8 changes: 5 additions & 3 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require('prism-react-renderer/themes/nightOwlLight');
const darkCodeTheme = require('prism-react-renderer/themes/nightOwl');
import {themes as prismThemes} from 'prism-react-renderer';
const lightCodeTheme = prismThemes.nightOwlLight;
const darkCodeTheme = prismThemes.nightOwl;

const webpack = require('webpack');
const {resolve} = require('path');

Expand Down Expand Up @@ -230,7 +232,7 @@ const config = {
// Optional: see doc section below
contextualSearch: true,
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search'
searchPagePath: false
},
prism: {
theme: lightCodeTheme,
Expand Down
21 changes: 14 additions & 7 deletions website/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "project-website",
"version": "9.1.0-alpha",
"version": "9.1.0-beta.1",
"private": true,
"description": "Website for vis.gl project",
"scripts": {
Expand All @@ -15,6 +15,7 @@
},
"dependencies": {
"@googlemaps/js-api-loader": "^1.16.0",
"@loaders.gl/core": "^4.2.0",
"@loaders.gl/i3s": "^4.2.0",
"@loaders.gl/las": "^4.2.0",
"@loaders.gl/obj": "^4.2.0",
Expand All @@ -41,16 +42,22 @@
"supercluster": "^8.0.1"
},
"devDependencies": {
"@docusaurus/core": "^2.2.0",
"@docusaurus/plugin-content-docs": "^2.2.0",
"@docusaurus/preset-classic": "^2.2.0",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "^3.6.3",
"@docusaurus/plugin-content-docs": "^3.6.3",
"@docusaurus/preset-classic": "^3.6.3",
"@mdx-js/react": "^3.1.0",
"algoliasearch": "^4.18.0",
"algoliasearch-helper": "^3.13.3",
"babel-plugin-styled-components": "^2.0.0",
"prism-react-renderer": "^1.2.1",
"prism-react-renderer": "^2.3.0",
"ts-node": "~10.9.1"
},
"browserslist": [
">0.2% and supports async-functions",
"not dead"
]
],
"volta": {
"node": "18.19.0",
"yarn": "1.22.19"
}
}
2 changes: 1 addition & 1 deletion website/src/components/example/examples-index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import React from 'react';
// Note: this is internal API and may change in a future release
// https://github.com/facebook/docusaurus/discussions/7457
import {useDocsSidebar} from '@docusaurus/theme-common/internal';
import {useDocsSidebar} from '@docusaurus/plugin-content-docs/client';
import useBaseUrl from '@docusaurus/useBaseUrl';

import {MainExamples, ExamplesGroup, ExampleCard, ExampleHeader, ExampleTitle} from './styled';
Expand Down
2 changes: 1 addition & 1 deletion website/src/examples-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ const sidebars = {
{
type: 'link',
label: 'Playground',
href: `playground`
href: `/playground`
}
]
}
Expand Down
5 changes: 4 additions & 1 deletion website/src/pages/playground.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// Copyright (c) vis.gl contributors

import React, {Suspense} from 'react';
import BrowserOnly from '@docusaurus/BrowserOnly';
import Layout from '@theme/Layout';
import styled from 'styled-components';

Expand Down Expand Up @@ -44,7 +45,9 @@ export default function Playground() {
<Layout>
<Container>
<Suspense>
<App />
<BrowserOnly>
<App />
</BrowserOnly>
</Suspense>
</Container>
</Layout>
Expand Down
Loading

0 comments on commit f9ae785

Please sign in to comment.