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

Upgrade to Docusaurus v3 #357

Merged
merged 2 commits into from
Nov 5, 2023
Merged

Upgrade to Docusaurus v3 #357

merged 2 commits into from
Nov 5, 2023

Conversation

ybiquitous
Copy link
Member

Which issue, if any, is this issue related to?

Closes #347

Is there anything in the PR that needs further explanation?

See the upgrade guide: https://docusaurus.io/docs/migration/v3

Summary:

  • Bump dependencies: Docusaurus and React
  • Move @docusaurus/* from devDependencies to dependencies because the official doc describes so.
  • Rewrite docusaurus.config.js in ESM

See the upgrade guide: https://docusaurus.io/docs/migration/v3

Summary:
- Bump dependencies: Docusaurus and React
- Move `@docusaurus/*` from `devDependencies` to `dependencies` because the official doc describes so.
- Rewrite `docusaurus.config.js` in ESM
package.json Show resolved Hide resolved
package.json Show resolved Hide resolved
@ybiquitous ybiquitous added pr: blocked is blocked by another issue or pr and removed pr: blocked is blocked by another issue or pr labels Nov 2, 2023
Copy link
Member

@jeddy3 jeddy3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw that Docuasurus v3 was released when catching up on my RSS feeds, and it's terrific to see you've already opened a PR @ybiquitous!

It's looking great.

On the deploy preview, it seems some of our custom CSS isn't active:

Screenshot 2023-11-05 at 11 13 18

The following aren't hidden:

  • the 2nd (auto-generated) "Rules" navigation item
  • the empty table headers on the Rules page

However, they are hidden when I run the site locally, which is strange. Any ideas?


Should we also adjust the "eslintConfig": { "settings": { "react": { "version": "17.02" }}} version too?

@ybiquitous
Copy link
Member Author

@jeddy3 Thanks for the review!

However, they are hidden when I run the site locally, which is strange. Any ideas?

Um..., the preview seems to be working in my browser. 🤔

image

Should we also adjust the "eslintConfig": { "settings": { "react": { "version": "17.02" }}} version too?

Good catch. Fixed with 345edf5.

Copy link
Member

@jeddy3 jeddy3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Um..., the preview seems to be working in my browser. 🤔

Very odd. It's probably something on my end then.

Marking as approved.

@ybiquitous ybiquitous merged commit 5f2e271 into main Nov 5, 2023
7 checks passed
@ybiquitous ybiquitous deleted the docusaurus-v3 branch November 5, 2023 13:12
ybiquitous added a commit that referenced this pull request Nov 13, 2023
I upgraded Docusaurus to v3 in #357, but I missed a breaking change for syntax highlighting.
This change adds the `prism.additionalLanguages` to the Docusaurus config.

See also:
- https://docusaurus.io/docs/migration/v3#prism-react-renderer-v20
- https://prismjs.com/#supported-languages
ybiquitous added a commit that referenced this pull request Nov 14, 2023
I upgraded Docusaurus to v3 in #357, but I missed a breaking change for syntax highlighting.
This change adds the `prism.additionalLanguages` to the Docusaurus config.

See also:
- https://docusaurus.io/docs/migration/v3#prism-react-renderer-v20
- https://prismjs.com/#supported-languages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Update to React 18
2 participants