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

Improve docs styling for code to be run in shell #6641

Merged
merged 3 commits into from Dec 21, 2017

Conversation

Projects
None yet
5 participants
@ashmaroli
Member

ashmaroli commented Dec 20, 2017

Current design:

jekyllrb com_docs_quickstart

With this patch..:

localhost_4000_docs_quickstart

@ashmaroli ashmaroli added the site label Dec 20, 2017

@ashmaroli ashmaroli requested a review from jekyll/documentation Dec 20, 2017

Show outdated Hide outdated docs/_sass/_style.scss Outdated
@mattr-

This comment has been minimized.

Show comment
Hide comment
@mattr-

mattr- Dec 20, 2017

Member

Nice work on this. I like that the terminal background is a bit darker which gives more contrast to the white text. I like that the title bar is a lighter color too.

I don't agree with the color change to the comments because they serve as instructions for what to do and now they're in danger of getting lost due to the lack of contrast. Could you tweak it such that they're still gray but just a lighter shade? I don't think it's necessary to go back to the blue but we definitely don't want to lose them.

Member

mattr- commented Dec 20, 2017

Nice work on this. I like that the terminal background is a bit darker which gives more contrast to the white text. I like that the title bar is a lighter color too.

I don't agree with the color change to the comments because they serve as instructions for what to do and now they're in danger of getting lost due to the lack of contrast. Could you tweak it such that they're still gray but just a lighter shade? I don't think it's necessary to go back to the blue but we definitely don't want to lose them.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Dec 20, 2017

Member

Looking around.., we already have a style similar to an OS chrome..

jekyllrb com_

Member

ashmaroli commented Dec 20, 2017

Looking around.., we already have a style similar to an OS chrome..

jekyllrb com_

@oe

This comment has been minimized.

Show comment
Hide comment
@oe

oe Dec 20, 2017

Member

@ashmaroli okay, that's fair then

Member

oe commented Dec 20, 2017

@ashmaroli okay, that's fair then

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Dec 20, 2017

Member

Looking around.., we already have a style similar to an OS chrome..

👍 Let's just use the existing style then, we don't need the extra macOS buttons here.

Member

DirtyF commented Dec 20, 2017

Looking around.., we already have a style similar to an OS chrome..

👍 Let's just use the existing style then, we don't need the extra macOS buttons here.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Dec 20, 2017

Member

To use the existing style would need to modify generated markup as well.. instead incorporated that style into this patch..
...kept the mac buttons since it immediately signals an app window chrome..
...also used a lighter-gray for the comment strings..

localhost_4000_docs_quickstart_mod

Member

ashmaroli commented Dec 20, 2017

To use the existing style would need to modify generated markup as well.. instead incorporated that style into this patch..
...kept the mac buttons since it immediately signals an app window chrome..
...also used a lighter-gray for the comment strings..

localhost_4000_docs_quickstart_mod

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Dec 21, 2017

Member

I tested and we can match the existing style without modifying the markup.

Member

DirtyF commented Dec 21, 2017

I tested and we can match the existing style without modifying the markup.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Dec 21, 2017

Member

@DirtyF Feel free to update the branch as you see fit.. 🙂

Member

ashmaroli commented Dec 21, 2017

@DirtyF Feel free to update the branch as you see fit.. 🙂

@DirtyF

DirtyF approved these changes Dec 21, 2017 edited

Thanks @ashmaroli for bringing better contrast and coherence

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Dec 21, 2017

Member

@jekyllbot: merge +site

Member

DirtyF commented Dec 21, 2017

@jekyllbot: merge +site

@jekyllbot jekyllbot merged commit d615257 into jekyll:master Dec 21, 2017

1 of 3 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
WIP ready for review
Details

@ashmaroli ashmaroli deleted the ashmaroli:docs-terminal-style branch Jan 4, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment