Updated Docusaurus to V3 #241
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
To upgrade to Docusaurus V3, the following actions have been performed:
- Local machine: install node.js `>=18.x`
- Upgrade the Docusaurus modules with the command `yarn upgrade @docusaurus/core@latest @docusaurus/plugin-client-redirects@latest @docusaurus/plugin-google-gtag@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@lates`
- Update `yarn.lock` with the required values:
- "@docusaurus/core": "3.0.0"
- "@docusaurus/preset-classic": "3.0.0"
- "@mdx-js/react": "^3.0.0"
- "prism-react-renderer": "^2.1.0"
- "react": "^18.2.0"
- "react-dom": "^18.2.0"
- "node": ">=18.0"
- The themes light and dark imports in `docusaurus.config.js` have been updated to use the MDX V3 syntax
- The `deploy.yml` action file has been updated to use node.js `>=18.x`
- Due to Docusaurus V3 using MDX V3, the references using `{ ... }` have been formatted as code to void errors
- The `theme/MDXComponents` file has been regenerated and updated with the previous values. This avoids errors with `details` component.
- The file `package-lock.json` has been removed
This PR also addresses:
rancher#55 / rancher#238 / rancher#240
Signed-off-by: Nuno do Carmo [email protected]
✅ Deploy Preview for elemental-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
frelon
approved these changes
Nov 21, 2023
Already done after the I created the PR. The checks show not successful because they ran before I updated the runner on Netlify. After the update, Netlify is now showing it's OK. |
Addresses rancher#242
frelon
pushed a commit
to frelon/elemental-docs
that referenced
this pull request
Nov 24, 2023
* Updated Docusaurus to V3
To upgrade to Docusaurus V3, the following actions have been performed:
- Local machine: install node.js `>=18.x`
- Upgrade the Docusaurus modules with the command `yarn upgrade @docusaurus/core@latest @docusaurus/plugin-client-redirects@latest @docusaurus/plugin-google-gtag@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@lates`
- Update `yarn.lock` with the required values:
- "@docusaurus/core": "3.0.0"
- "@docusaurus/preset-classic": "3.0.0"
- "@mdx-js/react": "^3.0.0"
- "prism-react-renderer": "^2.1.0"
- "react": "^18.2.0"
- "react-dom": "^18.2.0"
- "node": ">=18.0"
- The themes light and dark imports in `docusaurus.config.js` have been updated to use the MDX V3 syntax
- The `deploy.yml` action file has been updated to use node.js `>=18.x`
- Due to Docusaurus V3 using MDX V3, the references using `{ ... }` have been formatted as code to void errors
- The `theme/MDXComponents` file has been regenerated and updated with the previous values. This avoids errors with `details` component.
- The file `package-lock.json` has been removed
This PR also addresses:
rancher#55 / rancher#238 / rancher#240
Signed-off-by: Nuno do Carmo [email protected]
* Updated typescript module
Addresses rancher#242
---------
Signed-off-by: Nuno do Carmo [email protected]
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.
To upgrade to Docusaurus V3, the following actions have been performed:
Local machine: install node.js
>=18.xUpgrade the Docusaurus modules with the command
yarn upgrade @docusaurus/core@latest @docusaurus/plugin-client-redirects@latest @docusaurus/plugin-google-gtag@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@latesUpdate
yarn.lockwith the required values:The themes light and dark imports in
docusaurus.config.jshave been updated to use the MDX V3 syntaxThe
deploy.ymlaction file has been updated to use node.js>=18.xDue to Docusaurus V3 using MDX V3, the references using
{ ... }have been formatted as code to void errorsThe
theme/MDXComponentsfile has been regenerated and updated with the previous values. This avoids errors withdetailscomponentThe file
package-lock.jsonhas been removed This PR also addresses:Bump @mdx-js/react from 1.6.22 to 2.3.0 #55 / Bump @docusaurus/module-type-aliases from 2.4.3 to 3.0.0 #238 / Bump prism-react-renderer from 1.3.5 to 2.2.0 #240
Signed-off-by: Nuno do Carmo [email protected]