Skip to content

Commit caf051e

Browse files
committed
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.
1 parent dcea251 commit caf051e

File tree

2 files changed

+1
-8
lines changed

2 files changed

+1
-8
lines changed

doc/api_assets/style.css

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -679,11 +679,6 @@ kbd {
679679
visibility: hidden;
680680
}
681681

682-
.github_icon {
683-
vertical-align: middle;
684-
margin: -2px 3px 0 0;
685-
}
686-
687682
/* API reference sidebar */
688683
@media only screen and (min-width: 1025px) {
689684
.apidoc #column2 > .line {

tools/doc/html.mjs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -489,8 +489,6 @@ function altDocs(filename, docCreated, versions) {
489489
` : '';
490490
}
491491

492-
// eslint-disable-next-line max-len
493-
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>';
494492
function editOnGitHub(filename) {
495-
return `<li class="edit_on_github"><a href="/nodejs/node/edit/master/doc/api/${filename}.md">${githubLogo}Edit on GitHub</a></li>`;
493+
return `<li class="edit_on_github"><a href="/nodejs/node/edit/master/doc/api/${filename}.md">Edit on GitHub</a></li>`;
496494
}

0 commit comments

Comments
 (0)