Docusaurus v3 upgrade #128
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Requires more languages to be listed, not automatically included now
- Markup-templating required by ejs, must specify explicitly or build
breaks
- Update some language references in code blocks that aren't actually
supported by prism
TODO: Figure out typescript issue
Multiple type versions lead to type errors like this one https://github.com/software-mansion/react-native-svg/issues/1741\#issuecomment-1093812197
morganick
requested changes
Feb 16, 2024
Jpoliachik
approved these changes
Feb 16, 2024
Interesting, that wasn't showing up yesterday when I ran it but it's happening on a fresh checkout 🤔 fixing... |
|
Alright this should be good to go. As a follow-on I went through the dependabot alerts and made a PR to try to address the few that weren't resolved by this upgrade: #130 |
morganick
approved these changes
Feb 20, 2024
|
@morganick Oh yeah, --noEmit sounds fine to me, I'll add that. I think the typecheck command is just what docusaurus set by defualt. |
cdanwards
pushed a commit
that referenced
this pull request
Feb 28, 2024
* Update for docusaurus v3 versions
* Fix non-terminating image, I think this is the intended one
* Fixing prism post-upgrade
- Requires more languages to be listed, not automatically included now
- Markup-templating required by ejs, must specify explicitly or build
breaks
- Update some language references in code blocks that aren't actually
supported by prism
* Fix observer crash when navigating from homepage
* Update last plugin and clsx
* Actual fix for useIntersection
* Force a single resolution of react types
Multiple type versions lead to type errors like this one
https://github.com/software-mansion/react-native-svg/issues/1741\#issuecomment-1093812197
* Leave comment that gtag is not meant to work in dev
* Convert config to real typescript
* Re-swizzle DocItem/Footer as TS and add more fixes
* Type fixes and disallow unchecked indexed access
* Fix snippet typing issue with home page top bar
* Add a note about swizzling
* Don't emit on typecheck
cdanwards
pushed a commit
that referenced
this pull request
Feb 28, 2024
* Update for docusaurus v3 versions
* Fix non-terminating image, I think this is the intended one
* Fixing prism post-upgrade
- Requires more languages to be listed, not automatically included now
- Markup-templating required by ejs, must specify explicitly or build
breaks
- Update some language references in code blocks that aren't actually
supported by prism
* Fix observer crash when navigating from homepage
* Update last plugin and clsx
* Actual fix for useIntersection
* Force a single resolution of react types
Multiple type versions lead to type errors like this one
https://github.com/software-mansion/react-native-svg/issues/1741\#issuecomment-1093812197
* Leave comment that gtag is not meant to work in dev
* Convert config to real typescript
* Re-swizzle DocItem/Footer as TS and add more fixes
* Type fixes and disallow unchecked indexed access
* Fix snippet typing issue with home page top bar
* Add a note about swizzling
* Don't emit on typecheck
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Upgrades to Docusaurus v3, following these instructions: https://docusaurus.io/docs/migration/v3
This includes the following changes:
useIntersectionfor strict modea. Docusaurus config file is now TS
b. The one component we swizzled (DocItem/Footer) is now based on the official TS version
c. I added a few TS compiler options to more strictly check code and help prevent future bugs
a. While doing this, I noticed we were referencing some languages prism doesn't actually support, so updated those to supported ones.
This upgrade should make it easier to make future improvements to Docusaurus components like search.