Enable MDX descriptions for the API reference to be stored inside JSX blocks #194
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.
Inline MDX on its own would be fine, but without control over the CSS there's no way to render the description at full width. (This is surely going to fail in some edge cases, but I'd rather not mess with it any more than necessary right now.)
Spacing messed up because the description isn't inside the block yet:
Description outside the
Functionblock (existing approach), with emptyDescriptionblock:Moving the description inside the
Functionblock (new and preferred approach):Requires the following code changes, which have yet to be applied to all functions:
Note: Spaces are needed according to the Docusaurus site (MDX parser issue). Otherwise
childrenmay be empty?