FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: made code spans more visible by phillipj · Pull Request #3573 · nodejs/node · GitHub

/ node Public

doc: made code spans more visible - #3573

Closed
phillipj wants to merge 1 commit into
nodejs:masterfrom
phillipj:doc-code-visibility
ConversationCommits (1)ChecksFiles changed
Closed

doc: made code spans more visible#3573
phillipj wants to merge 1 commit into
nodejs:masterfrom
phillipj:doc-code-visibility

Conversation

phillipj commented Oct 28, 2015

Copy link
Copy Markdown
Member

This makes the code spans in the API docs alot more visible and therefore readable by adding some background color. Its more or less what github.com does, and what we decided to do on nodejs.org with nodejs/nodejs.org#146.

Closes an issue raised about API docs readability in nodejs/nodejs.org#121.

mscdex added the doc Issues and PRs related to the documentations. label Oct 28, 2015

evanlucas commented Oct 29, 2015

Copy link
Copy Markdown
Contributor

LGTM

silverwind reviewed Oct 29, 2015
View reviewed changes
Comment thread doc/api_assets/style.css Outdated

silverwind Oct 29, 2015

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think a padding of 0.2em 0.4em would look better visually, it's what GitHub does too (They do it through a unicode space in :before and :after) to make the left and right padding slightly larger.

jasnell commented Oct 29, 2015

Copy link
Copy Markdown
Member

LGTM

phillipj force-pushed the doc-code-visibility branch from cca141e to ef2e668 Compare October 29, 2015 21:22

phillipj commented Oct 29, 2015

Copy link
Copy Markdown
Member Author

I think a padding of 0.2em 0.4em would look better visually

@silverwind agreed, just updated with a little extra horizontal padding.

silverwind commented Oct 29, 2015

Copy link
Copy Markdown
Contributor

LGTM

One thing that bugs me a bit is that #f2f5f0 is hard to discern from the #fff background, at least on my display, but that applies to code blocks as well. Maybe a tiny bit darker would be nice, but that's material for another PR.

silverwind pushed a commit that referenced this pull request Oct 29, 2015
doc: made code spans more visible in the API docs
d995b72 
This makes the code spans in the API docs more visible and
therefore readable by adding some background color.

PR-URL: #3573
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>

silverwind commented Oct 29, 2015

Copy link
Copy Markdown
Contributor

Thanks. Landed in d995b72.

silverwind closed this Oct 29, 2015
phillipj deleted the doc-code-visibility branch October 29, 2015 22:01
phillipj mentioned this pull request Oct 29, 2015
Closed

phillipj commented Nov 4, 2015

Copy link
Copy Markdown
Member Author

Any chance this could be backported to v4.x and v5.x aswell @silverwind?

jasnell commented Nov 4, 2015

Copy link
Copy Markdown
Member

There shouldn't be any problem getting this in to v4 :-)

Fishrock123 mentioned this pull request Nov 6, 2015
Closed
rvagg pushed a commit that referenced this pull request Nov 7, 2015
doc: made code spans more visible in the API docs
90723af 
This makes the code spans in the API docs more visible and
therefore readable by adding some background color.

PR-URL: #3573
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Fishrock123 mentioned this pull request Nov 11, 2015
Merged
MylesBorins pushed a commit that referenced this pull request Nov 16, 2015
doc: made code spans more visible in the API docs
08ab9f3 
This makes the code spans in the API docs more visible and
therefore readable by adding some background color.

PR-URL: #3573
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>

MylesBorins commented Nov 16, 2015

Copy link
Copy Markdown
Contributor

landed in lts-v4.x-staging as 08ab9f3

MylesBorins commented Nov 16, 2015

Copy link
Copy Markdown
Contributor

@silverwind does this need a land-on-v5.x tag if it is on master?

silverwind commented Nov 16, 2015

Copy link
Copy Markdown
Contributor

@thealphanerd No, that tag was unnecessary ;)

MylesBorins commented Nov 16, 2015

Copy link
Copy Markdown
Contributor

phillipj commented Nov 17, 2015

Copy link
Copy Markdown
Member Author

Thanks @thealphanerd!

rvagg mentioned this pull request Nov 17, 2015
Closed
rvagg pushed a commit that referenced this pull request Dec 4, 2015
doc: made code spans more visible in the API docs
feffea0 
This makes the code spans in the API docs more visible and
therefore readable by adding some background color.

PR-URL: #3573
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
jasnell mentioned this pull request Dec 17, 2015
Closed
jasnell pushed a commit that referenced this pull request Dec 17, 2015
doc: made code spans more visible in the API docs
6db4392 
This makes the code spans in the API docs more visible and
therefore readable by adding some background color.

PR-URL: #3573
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
jasnell pushed a commit that referenced this pull request Dec 23, 2015
doc: made code spans more visible in the API docs
13bec54 
This makes the code spans in the API docs more visible and
therefore readable by adding some background color.

PR-URL: #3573
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL