Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Update markdown parser to remove backticks from description #30495

Merged

Conversation

aefox
Copy link
Contributor

@aefox aefox commented Jan 4, 2022

On https://mui.com/customization/theme-components/ the page description element (which is <p class="description">) contains backticks which are rendered incorrectly (at least compared to how the backticks work for markdown).

Preview:
image

Looking into understanding why that happens I found out that the description is rendered in the head of the page. Looking more into it I found out that the title is rendered the same, but the title already was trimming the backtics. So I added trimming of the backtics for the description as well.

While this makes sense to me, obviously I cannot grasp the entire set of implications. Easiest thing to do for now, without introducing this change, would be to remove the backticks from description in the mentioned file.

Deploy preview: https://deploy-preview-30495--material-ui.netlify.app/customization/theme-components/

@mui-pr-bot
Copy link

mui-pr-bot commented Jan 4, 2022

No bundle size changes

Generated by 🚫 dangerJS against e4c7a0b

@danilo-leal danilo-leal changed the title docs: Update markdown parser to remove backticks from description [docs] Update markdown parser to remove backticks from description Jan 4, 2022
@danilo-leal danilo-leal requested a review from a team January 4, 2022 17:55
@danilo-leal danilo-leal added the docs Improvements or additions to the documentation label Jan 4, 2022
@siriwatknp
Copy link
Member

@aefox I still see the backtick (`) that wraps "components".

@aefox
Copy link
Contributor Author

aefox commented Jan 5, 2022

@siriwatknp that is correct, I did not remove that from the actual mentioned md file in the initial change set. The reason why I didn't do that was because I spent some extra time trying to find a way to still achieve the desired initial intention (and that is to emphasise the components word in the page). I was able to do that by replacing the `` with html's <code> and it worked, but yeah, I got a different series of issues which I tried figuring out if there is a way of fixing them by reusing something existing in the codebase.

Since I couldn't find any cool way of achieving both needs (having a proper text sentence in the header and good looking UI emphasised render) I have removed the backticks now.

Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thank you so much for the fix!

@siriwatknp siriwatknp merged commit 06419b9 into mui:master Jan 10, 2022
@aefox aefox deleted the markdown-parser-remove-backticks-from-description branch January 10, 2022 14:18
wladimirguerra pushed a commit to wladimirguerra/material-ui that referenced this pull request Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants