diff options
author | Rich Trott <rtrott@gmail.com> | 2021-07-03 10:18:24 -0700 |
---|---|---|
committer | Michaƫl Zasso <targos@protonmail.com> | 2021-09-04 12:46:07 +0200 |
commit | 8c569cef88be9e668ace404b43c7438037645cb0 (patch) | |
tree | 33b91a9370e03a831fe516c7dfb834a4c744b493 | |
parent | 40e46321b01ef13fbad1c66152ee76aa2105eac1 (diff) | |
download | node-new-8c569cef88be9e668ace404b43c7438037645cb0.tar.gz |
doc: remove GitHub mark
Judging from https://github.com/logos, we are misusing the GitHub mark.
That page indicates to not change the color (we change it from black to
green). Less clear, it says "Use the Mark in social buttons to link to
your GitHub profile or project" which isn't exactly what we're doing but
also isn't not what we're doing?
This might be an indication of my eyesight getting worse as I get older,
but I think the size that we display the mark at by default makes it not
entirely recognizable as the GitHub mark. Lastly, there's the
philosophical issue of whether we should display a commercial entity's
mark on our web pages in this particular instance. (For me, the answer
is "maybe".)
All told, I think we can remove it without damaging usability on the
website, so let's do it.
PR-URL: https://github.com/nodejs/node/pull/39251
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
-rw-r--r-- | doc/api_assets/style.css | 5 | ||||
-rw-r--r-- | tools/doc/html.mjs | 4 |
2 files changed, 1 insertions, 8 deletions
diff --git a/doc/api_assets/style.css b/doc/api_assets/style.css index c1f648eec9..b1c8a763a6 100644 --- a/doc/api_assets/style.css +++ b/doc/api_assets/style.css @@ -681,11 +681,6 @@ kbd { visibility: hidden; } -.github_icon { - vertical-align: middle; - margin: -2px 3px 0 0; -} - /* API reference sidebar */ @media only screen and (min-width: 1025px) { .apidoc #column2 > .line { diff --git a/tools/doc/html.mjs b/tools/doc/html.mjs index 139d236d80..4d91893c9e 100644 --- a/tools/doc/html.mjs +++ b/tools/doc/html.mjs @@ -497,8 +497,6 @@ function altDocs(filename, docCreated, versions) { ` : ''; } -// eslint-disable-next-line max-len -const githubLogo = '<span class="github_icon"><svg height="16" width="16" viewBox="0 0 16.1 16.1" fill="currentColor"><path d="M8 0a8 8 0 0 0-2.5 15.6c.4 0 .5-.2.5-.4v-1.5c-2 .4-2.5-.5-2.7-1 0-.1-.5-.9-.8-1-.3-.2-.7-.6 0-.6.6 0 1 .6 1.2.8.7 1.2 1.9 1 2.4.7 0-.5.2-.9.5-1-1.8-.3-3.7-1-3.7-4 0-.9.3-1.6.8-2.2 0-.2-.3-1 .1-2 0 0 .7-.3 2.2.7a7.4 7.4 0 0 1 4 0c1.5-1 2.2-.8 2.2-.8.5 1.1.2 2 .1 2.1.5.6.8 1.3.8 2.2 0 3-1.9 3.7-3.6 4 .3.2.5.7.5 1.4v2.2c0 .2.1.5.5.4A8 8 0 0 0 16 8a8 8 0 0 0-8-8z"/></svg></span>'; function editOnGitHub(filename) { - return `<li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/${filename}.md">${githubLogo}Edit on GitHub</a></li>`; + return `<li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/${filename}.md">Edit on GitHub</a></li>`; } |