Skip to content

Commit 03eafc9

Browse files
authored
chore: Update Docusaurus to 3.7.0 (#36)
* Add script for updating docusaurus * Bump docusaurus version * Add readme section for updating docusaurus * fix JSX import in React 19 * Fix formatting * Comment out broken anchors
1 parent 19471dd commit 03eafc9

File tree

8 files changed

+3395
-2702
lines changed

8 files changed

+3395
-2702
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,21 @@ yarn start
6868
A new browser tab will open at http://localhost:3000, reflecting any changes
6969
made to the files.
7070

71+
### Updating docusaurus
72+
73+
To update Docusaurus correctly, execute the following command:
74+
75+
```
76+
yarn upgrade @docusaurus -L
77+
```
78+
79+
Next, remove the `yarn.lock` file along with the `node_modules` and `build` directories. After deletion, regenerate the necessary files with updated dependency versions by running:
80+
81+
```
82+
yarn install
83+
```
84+
85+
7186
## Editing the documentation
7287

7388
### Creating documents

docs/leo-rover/integrations/legacy/arbotix.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -297,8 +297,8 @@ rostopic pub /dynamixel1/command std_msg/Float64 -- 0.0
297297

298298
:::info
299299

300-
The maximum angle range for a Dynamixel servo is [-150, 150] degrees which is equal
301-
to approximately [-2.62, 2.62] in radians
300+
The maximum angle range for a Dynamixel servo is [-150, 150] degrees which is
301+
equal to approximately [-2.62, 2.62] in radians
302302

303303
:::
304304

docs/rapha-rover/specification/ros-api.mdx

+13-12
Original file line numberDiff line numberDiff line change
@@ -533,16 +533,17 @@ string status_message
533533
https://docs.ros2.org/latest/api/tf2_msgs/msg/TFMessage.html
534534
[rapha_interfaces/msg/BatteryMode]: #msg-battery-mode
535535
[rapha_interfaces/msg/BatteryState]: #msg-battery-state
536-
[rapha_interfaces/msg/ImuDiagnostics]: #msg-imu-diagnostics
537-
[rapha_interfaces/msg/Led]: #msg-led
538-
[rapha_interfaces/msg/LedColor]: #msg-led-color
539-
[rapha_interfaces/msg/LedPanel]: #msg-led-panel
540-
[rapha_interfaces/msg/LedPanelState]: #msg-led-panel-state
536+
537+
{/* [rapha_interfaces/msg/ImuDiagnostics]: #msg-imu-diagnostics */}
538+
[rapha_interfaces/msg/Led]: #msg-led [rapha_interfaces/msg/LedColor]:
539+
#msg-led-color [rapha_interfaces/msg/LedPanel]: #msg-led-panel
540+
{/* [rapha_interfaces/msg/LedPanelState]: #msg-led-panel-state */}
541541
[rapha_interfaces/msg/LedState]: #msg-led-state
542-
[rapha_interfaces/msg/LedStripState]: #msg-led-strip-state
543-
[rapha_interfaces/msg/MotorDiagnostics]: #msg-motor-diagnostics
544-
[rapha_interfaces/msg/PowerSystemState]: #msg-power-system-state
545-
[rapha_interfaces/msg/SteeringMode]: #msg-steering-mode
546-
[rapha_interfaces/srv/SetBatteryModes]: #srv-set-battery-modes
547-
[rapha_interfaces/srv/SetLeds]: #srv-set-leds
548-
[rapha_interfaces/srv/SetSteeringMode]: #srv-set-steering-mode
542+
543+
{/* [rapha_interfaces/msg/LedStripState]: #msg-led-strip-state */}
544+
{/* [rapha_interfaces/msg/MotorDiagnostics]: #msg-motor-diagnostics */}
545+
{/* [rapha_interfaces/msg/PowerSystemState]: #msg-power-system-state */}
546+
{/* [rapha_interfaces/msg/SteeringMode]: #msg-steering-mode */}
547+
{/* [rapha_interfaces/srv/SetBatteryModes]: #srv-set-battery-modes */}
548+
{/* [rapha_interfaces/srv/SetLeds]: #srv-set-leds */}
549+
{/* [rapha_interfaces/srv/SetSteeringMode]: #srv-set-steering-mode */}

package.json

+14-14
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,26 @@
1818
"spellcheck": "cspell \"**/*.mdx\""
1919
},
2020
"dependencies": {
21-
"@docusaurus/core": "3.5.2",
22-
"@docusaurus/plugin-client-redirects": "3.5.2",
23-
"@docusaurus/preset-classic": "3.5.2",
24-
"@mdx-js/react": "^3.0.1",
21+
"@docusaurus/core": "3.7.0",
22+
"@docusaurus/plugin-client-redirects": "3.7.0",
23+
"@docusaurus/preset-classic": "3.7.0",
24+
"@mdx-js/react": "^3.1.0",
2525
"clsx": "^2.1.0",
2626
"medium-zoom": "^1.1.0",
27-
"prism-react-renderer": "^2.3.1",
28-
"react": "^18.0.0",
29-
"react-dom": "^18.0.0",
27+
"prism-react-renderer": "^2.4.1",
28+
"react": "^19.0.0",
29+
"react-dom": "^19.0.0",
3030
"react-lite-youtube-embed": "^2.4.0",
31-
"rehype-katex": "7",
31+
"rehype-katex": "7.0.1",
3232
"remark-math": "6"
3333
},
3434
"devDependencies": {
35-
"@docusaurus/module-type-aliases": "3.5.2",
36-
"@docusaurus/tsconfig": "3.5.2",
37-
"@docusaurus/types": "3.5.2",
38-
"cspell": "^8.8.4",
39-
"prettier": "^3.3.1",
40-
"typescript": "^5.4.5"
35+
"@docusaurus/module-type-aliases": "3.7.0",
36+
"@docusaurus/tsconfig": "3.7.0",
37+
"@docusaurus/types": "3.7.0",
38+
"cspell": "^8.17.3",
39+
"prettier": "^3.4.2",
40+
"typescript": "^5.7.3"
4141
},
4242
"browserslist": {
4343
"production": [

src/components/ImageZoom/index.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { useRef, ComponentProps, RefCallback } from 'react';
1+
import { useRef, ComponentProps, RefCallback, JSX } from 'react';
22
import mediumZoom, { Zoom } from 'medium-zoom';
33
import styles from './styles.module.css';
44

src/data/features.tsx

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { JSX } from 'react';
2+
13
export type FeatureItem = {
24
name: string;
35
image: {

src/pages/index.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import Link from '@docusaurus/Link';
88
import ThemedImage from '@theme/ThemedImage';
99

1010
import styles from './index.module.css';
11+
import { JSX } from 'react';
1112

1213
function HomepageHeader() {
1314
const { siteConfig } = useDocusaurusContext();

0 commit comments

Comments
 (0)