[docs-infra] Add a rawDescriptions option
#44390
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
Netlify deploy previewhttps://deploy-preview-44390--material-ui.netlify.app/ Bundle size report |
michaldudak
approved these changes
Nov 12, 2024
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.
Currently,
api-docs-builderalways renders JSDoc descriptions from markdown into HTML.For the upcoming Base UI docs, we want the docs themselves to be responsible for rendering that so that component descriptions can be processed using the same MDX pipeline like the rest of the docs contents.
This PR adds a
rawDescriptionsoption toProjectSettings. Whentrue:No changes produced by
docs:api:buildin the current configs.