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-infra] Strange styles applied to Markdown blockquotes #39643

Closed
mapache-salvaje opened this issue Oct 28, 2023 · 6 comments
Closed

[docs-infra] Strange styles applied to Markdown blockquotes #39643

mapache-salvaje opened this issue Oct 28, 2023 · 6 comments
Assignees
Labels
docs Improvements or additions to the documentation scope: docs-infra Specific to the docs-infra product

Comments

@mapache-salvaje
Copy link
Contributor

I never noticed this before, but the blockquotes on this page have some funky styles applied to them:

Screenshot 2023-10-28 at 10 13 24 AM
  • The first blockquote has a double quote appended to it, but the second only has a single quote for some reason
  • There's some weird extra space added to the text that's in code-blocks
    • This space only seems to be applied in the context of the blockquote - it doesn't happen if the code block is italicized outside of the blockquote

We pretty much never use blockquotes in the docs—they were phased out in favor of more informative callouts—but they should still look nice when they are present. 😁

In any case, this particular page does not need blockquotes, so I'm going to open a PR to replace this instance with a warning or error callout.

@mapache-salvaje mapache-salvaje added docs Improvements or additions to the documentation scope: docs-infra Specific to the docs-infra product labels Oct 28, 2023
@danilo-leal danilo-leal moved this to Todo in Docs-infra Oct 28, 2023
@danilo-leal
Copy link
Contributor

danilo-leal commented Oct 28, 2023

Uhm... this is weird — not exactly sure about the reason for the single quote there. 🤔 The extra space within the code block seems to be coming from the text-indent property. I'll check it out; appreciate you for reporting!

As a bit of context, we used <blockquotes> for callouts before having the :::success syntax. After implementing that, I changed the quote tag styles to properly convey a citation extract, something pulled out from some source, hence this specific style. But in the screenshot's case, it's indeed more appropriate to use a proper callout 👌

@danilo-leal danilo-leal self-assigned this Nov 9, 2023
@oliviertassinari
Copy link
Member

I think we can close this issue. We are not supposed to have code in quotes.

@danilo-leal
Copy link
Contributor

danilo-leal commented Dec 4, 2023

This issue is still valid, as even though I agree this scenario shouldn't happen, it should also not get broken! 😄 Overall, the blockquote element is still nice to be preserved and reserved for whenever we want to share actual citations.

There might be hidden instances of it being used for callouts, though, as that was our previous solution for it. Sam has specifically fixed, in the above-linked PR, the one from the screenshot so that's all good. But I still have to figure out what's messing up the quote styles — I have a hunch it's something to do with the text indentation property I'm using to push content from the first line to the right.

@oliviertassinari
Copy link
Member

There is only one place in the docs that takes advantage of quotes (to my knowledge)

https://mui.com/material-ui/guides/api/

@danilo-leal
Copy link
Contributor

danilo-leal commented Jan 2, 2024

Closing this issue as this problem should be fixed by #40347. Here's a quick before

Screenshot 2024-01-02 at 23 38 11

and after

Screenshot 2024-01-02 at 23 38 15

— changing the blockquote's content from open-quotes to seemed to do the trick!

@github-project-automation github-project-automation bot moved this from Backlog to Done in Docs-infra Jan 2, 2024
@oliviertassinari
Copy link
Member

@danilo-leal 👌

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 scope: docs-infra Specific to the docs-infra product
Projects
Status: Done
Development

No branches or pull requests

3 participants