Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

Working with Rules: Unexpected large font in SourceCode documentation #491

Open
platinumazure opened this issue Jun 28, 2018 · 11 comments
Open
Labels
documentation Relates to ESLint's documentation

Comments

@platinumazure
Copy link
Member

In the SourceCode section of "Working with Rules", there's a section in which the different range/skip/count options are documented for some of the newer SourceCode methods. That section is rendered with a larger font than the surrounding content.

I opened the issue up here because I assumed this might be a CSS problem. If it's a problem with the source content (i.e., the markdown), let me know and I can move this to eslint/eslint.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Jun 28, 2018
@platinumazure platinumazure added documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Jun 28, 2018
@AlokTakshak
Copy link
Contributor

@platinumazure
image
as we can see blockquote is providing the font size 21.25px;

@AlokTakshak
Copy link
Contributor

@platinumazure
It is in styles/main.css
should i update it and raise a PR?

@platinumazure
Copy link
Member Author

@AlokTakshak Nice find! Feel free to raise a PR, but be careful-- I think we only really need the code samples to use a smaller font size. Block quotes for actual prose should probably still be larger size. So I would recommend creating a more specific selector to override for code samples, if at all possible. Thanks for taking a look!

@AlokTakshak
Copy link
Contributor

AlokTakshak commented May 7, 2019

@platinumazure
blockquote p, ul { font-size: 17px; }
I think this should be fine for now or we need to give for all elements inside blockquote
blockquote * { font-size: 17px; }
#566

@btmills
Copy link
Member

btmills commented May 30, 2019

https://github.com/eslint/eslint/blob/9590587cef74c936ef9b7ce2d22a71e2fd0fbbc4/docs/developer-guide/working-with-rules.md#L415-L429

After taking a look at this, my opinion is that this is an issue with the Markdown source and not the CSS. That section is written as a blockquote with the > prefixes, but it seems that was being used for indentation rather than quote-like semantics. If we don't need them to be a blockquote, removing the > prefix from those lines would fix this. What do you all think?

@AlokTakshak
Copy link
Contributor

@btmills Yeah that will also work, do you want me to remove the > prefix?

@platinumazure
Copy link
Member Author

@AlokTakshak Let's try that first and see how everything looks. If we need to do any further changes, we could do them either in the same PR or in a separate PR. Thanks!

@btmills Please speak up if you feel differently.

@AlokTakshak
Copy link
Contributor

@AlokTakshak Let's try that first and see how everything looks. If we need to do any further changes, we could do them either in the same PR or in a separate PR. Thanks!

@btmills Please speak up if you feel differently.

so we are going with initial (i.e adding css property) for now?

@platinumazure
Copy link
Member Author

@AlokTakshak Sorry for being unclear. I meant we should change the Markdown source first since it's semantically incorrect. Let's fix that first, then we can decide if some CSS change might be needed later. Thanks!

@AlokTakshak
Copy link
Contributor

@AlokTakshak Sorry for being unclear. I meant we should change the Markdown source first since it's semantically incorrect. Let's fix that first, then we can decide if some CSS change might be needed later. Thanks!

ok, i will make changes in same PR

AlokTakshak referenced this issue in AlokTakshak/eslint.github.io Jun 6, 2019
@AlokTakshak
Copy link
Contributor

@platinumazure I have removed the '>' prefix, you can check the PR

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Relates to ESLint's documentation
Projects
None yet
Development

No branches or pull requests

3 participants