Skip to content

doc: made code spans more visible - #3573

Closed
phillipj wants to merge 1 commit into
nodejs:masterfrom
phillipj:doc-code-visibility
Closed

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

Conversation

@phillipj

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.

skjermbilde 2015-10-28 kl 21 01 38

@mscdexmscdex added the doc Issues and PRs related to the documentations. label Oct 28, 2015
@evanlucas

Copy link
Copy Markdown
Contributor

LGTM

Comment threaddoc/api_assets/style.css Outdated

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.

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

Copy link
Copy Markdown
Member

LGTM

@phillipj

Copy link
Copy Markdown
MemberAuthor

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

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

skjermbilde 2015-10-29 kl 22 20 17

@silverwind

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
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

Copy link
Copy Markdown
Contributor

Thanks. Landed in d995b72.

@phillipj
phillipj deleted the doc-code-visibility branch October 29, 2015 22:01
@phillipj

Copy link
Copy Markdown
MemberAuthor

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

@jasnell

Copy link
Copy Markdown
Member

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

@Fishrock123Fishrock123 mentioned this pull request Nov 6, 2015
rvagg pushed a commit that referenced this pull request Nov 7, 2015
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>
@Fishrock123Fishrock123 mentioned this pull request Nov 11, 2015
MylesBorins pushed a commit that referenced this pull request Nov 16, 2015
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

Copy link
Copy Markdown
Contributor

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

@MylesBorins

Copy link
Copy Markdown
Contributor

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

@silverwind

Copy link
Copy Markdown
Contributor

@thealphanerd No, that tag was unnecessary ;)

@MylesBorins

Copy link
Copy Markdown
Contributor

thumbs up

@phillipj

Copy link
Copy Markdown
MemberAuthor

Thanks @thealphanerd!

rvagg pushed a commit that referenced this pull request Dec 4, 2015
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>
@jasnelljasnell mentioned this pull request Dec 17, 2015
jasnell pushed a commit that referenced this pull request Dec 17, 2015
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
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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@phillipj@evanlucas@jasnell@silverwind@MylesBorins@mscdex