docs(ui5-text): use md syntax instead of HTML #12703
Merged
Conversation
This file contains hidden or 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
Collaborator
|
🧹 Preview deployment cleaned up: https://pr-12703--ui5-webcomponents.netlify.app |
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.
In UI5WCR we leverage the JSDoc comment for our docs (JSDoc & Storybook story) of UI5WC components via the CEM. I noticed that for the
TextHTML instead of markdown syntax was used which is why our matcher doesn't find the headings for example. As theTextseems to be the only component using HTML in the description, I've adjusted it.In case HTML is used there on purpose, please let me know. We will then handle it in our wrapper script.
Note: For us, only the headings are relevant in this case, but I replaced all HTML tags with their Markdown equivalent.