Skip to content

DRAFT: Update docusaurus version3 #2731

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

Closed
wants to merge 8 commits into from

Conversation

discombobulateme
Copy link

This PR updates the Docusaurus version to 3.0 in order to fix several vulnerabilities and issues and keep up with the latest versions. Several other packages have also been updated.

The major change is forcing the minimum Node version to 18.

Other changes are minor, as it introduces MDX files. MDX will now compile Markdown content more strictly and with subtle differences. We can still use .md, but .mdx makes it easier to spot errors using linter, which improves readability in JSX or HTML code in the files.

This PR fixes previous errors in the .md files and changes them to .mdx to make it easier to spot the changes and slowly prepare to change all files to .mdx

### Resources:
Docusaurus 3 Migration Documentation

@discombobulateme discombobulateme requested review from a team and rick-bt as code owners April 18, 2024 09:13
In this mode you can create your own template in the same way as it is done for Request Body, the advantage here is that you can print the variable to check if all is correct (Body cannot be printed).

You can learn more about this mode by checking out [the example](/api-testing/use-cases/set-variable/#mode-language).
</details>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Adding a new line above this resolved a transpiling issue.

@@ -26,9 +26,9 @@ We do not support [Allow-listing static IPs](/basics/data-center-endpoints/). We

1. First, you'll need to create a YAML configuration file. From a text editor or IDE, create a file called **api-config.yaml**, then copy and paste it into the template below.

<!-- :::caution Important
{/* :::caution Important
Copy link
Collaborator

Choose a reason for hiding this comment

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

This warning is no longer hidden. This comment syntax does not work.

@discombobulateme discombobulateme deleted the update-docusaurus-version3 branch May 2, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants