[V3] Improved Docusaurus 3 compatibility #676
Closed
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
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.
Description
Improved escaped descriptions and headers, introduced typing for sidebars.
Motivation and Context
The first two items are pretty much required for a proper Docusaurus 3 support. The last one introduces typed sidebars which has improved support in Docusaurus 3.
There is one issue which I am unsure to fully resolve. HTML sidebar items are broken in Docusaurus 3.0.0 and hence an upgrade to 3.0.1 was needed to make sure versioned sidebars function as expected. However, this now introduces an
Hook is called outside the <DocProvider>error, which I am unable to replicate in other projects. This error seems to be caused by the@theme/ApiItemcomponent.How Has This Been Tested?
Tested by hand, using personal OpenAPI specifications.
Types of changes
Checklist