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

Updated code CSS wordbreak settings #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated code CSS wordbreak settings #8

wants to merge 1 commit into from

Conversation

ascopes
Copy link

@ascopes ascopes commented Jul 31, 2021

Updates <code> tag CSS to enable breaking on word boundaries rather than
on any character. This stops things like package names breaking mid-word rather
than on the closest appropriate period character, improving readability.

Before (note the io.netty.example part):

image

After:

image

Updates <code> tag CSS to enable breaking on word boundaries rather than
on any character. This stops things like package names breaking mid-word rather
than on the closest appropriate period character, improving readability.
@trustin
Copy link
Member

trustin commented Aug 3, 2021

IIRC This was intentional because the class names can get quite long, making the paragraph look bad if we don't break it.

@ascopes
Copy link
Author

ascopes commented Aug 13, 2021

@trustin if this is the case, there might be a way to break these up using a JS script similar to http://heap.ch/blog/2016/01/19/camelwrap/

It still doesnt fix the issue for those not using JS, but it will improve the situation.

Perhaps implementing the default with a JS shim to alter to this as default may be beneficial?

@trustin
Copy link
Member

trustin commented Aug 25, 2021

@ascopes CamelWrap sounds like a good workaround. Could you update this PR to apply CamelWrap so most users see nicely broken identifiers?

@ascopes
Copy link
Author

ascopes commented Aug 25, 2021

Will take a look at the weekend!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants