feat: custom doc-layout components #1611
Merged
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.
Summary
The
DocLayout
uses internal components to render MDX nodes. There is no documented way (as far as I can tell) to override these nodes without providing an entirely customDocLayout
component altogether.To address this, allow the user to provide
components
to theLayout
component. In the future, maybe the DocLayout could be extended to handle arbitrary nodes as well.Related Issue
Related to #1362 because this feature will allow the user to override and customize known MDX nodes.
Checklist
[ ] Tests updated (or not required).