Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: change color of doctag on night mode #38652

Closed
wants to merge 1 commit into from
Closed

doc: change color of doctag on night mode #38652

wants to merge 1 commit into from

Conversation

Ayase-252
Copy link
Member

Demo:

Screen Shot 2021-05-12 at 19 57 00

Fixes: #38641

@github-actions github-actions bot added the doc Issues and PRs related to the documentations. label May 12, 2021
DerekNonGeneric
DerekNonGeneric approved these changes May 12, 2021
View reviewed changes
Copy link
Contributor

@DerekNonGeneric DerekNonGeneric left a comment

Choose a reason for hiding this comment

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

Sweet!

Thanks, you can do .hljs-type if you want to too, but that would also need the light-mode styles too, so probably not in this PR.

/cc @nodejs/documentation as an FYI

@Ayase-252
Copy link
Member Author

@DerekNonGeneric

I think it is a great idea. I will open other PR to adjust .hljs-type.

@DerekNonGeneric
Copy link
Contributor

DerekNonGeneric commented May 12, 2021 •
edited
Loading

@Ayase-252, that sounds like a good idea! Pick a nice color for .hljs-type please.

It should be distinguishable from the JSDoc tag (not the same color). Thanks in advance. :)

@DerekNonGeneric DerekNonGeneric added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 12, 2021
@DerekNonGeneric
Copy link
Contributor

DerekNonGeneric commented May 12, 2021 •
edited
Loading

/to @Ayase-252 check out what GitHub has done here.

They are like whitish or something in the dark mode, so you may not want to diverge too far from that.

image

That is a gist in darkmode, so check it for yourself.

@Ayase-252
Copy link
Member Author

Ayase-252 commented May 12, 2021 •
edited
Loading

@DerekNonGeneric

OK, will check.

Looks like Github uses same color of variable to .hljs-type. Let's do the same to see how it looks in Node.js doc.

@DerekNonGeneric
Copy link
Contributor

DerekNonGeneric commented May 12, 2021 •
edited
Loading

@Ayase-252, they use a different syntax highlighter (and it is broken as you can see).

It is probably best to hold off on making the PR if this is challenging, but I will keep you posted if I make any progress.

@Ayase-252
Copy link
Member Author

@DerekNonGeneric
OK, I have just noticed some tiny "edge case" around multi-line type annotation (see * is somehow white), after making a couple of changes.

Screen Shot 2021-05-12 at 23 21 57

Screen Shot 2021-05-12 at 23 23 51

FYI, vscode seems do the job right.

Screen Shot 2021-05-12 at 23 43 54

I think this PR is free from the minor issue.

@jasnell
Copy link
Member

jasnell commented May 14, 2021

Landed in 67ecd05

@jasnell jasnell closed this May 14, 2021
jasnell pushed a commit that referenced this pull request May 14, 2021
@Ayase-252 @jasnell
doc: change color of doctag on night mode
67ecd05 
Fixes: #38641

PR-URL: #38652
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request May 17, 2021
@Ayase-252 @targos
doc: change color of doctag on night mode
c4b161c 
Fixes: #38641

PR-URL: #38652
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@targos targos mentioned this pull request May 18, 2021
Merged
targos pushed a commit that referenced this pull request May 30, 2021
@Ayase-252 @targos
doc: change color of doctag on night mode
5405b60 
Fixes: #38641

PR-URL: #38652
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Jun 5, 2021
@Ayase-252 @targos
doc: change color of doctag on night mode
0bcf497 
Fixes: #38641

PR-URL: #38652
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Jun 5, 2021
@Ayase-252 @targos
doc: change color of doctag on night mode
9a7950f 
Fixes: #38641

PR-URL: #38652
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@targos targos mentioned this pull request Jun 6, 2021
Merged
targos pushed a commit that referenced this pull request Jun 11, 2021
@Ayase-252 @targos
doc: change color of doctag on night mode
fa35c06 
Fixes: #38641

PR-URL: #38652
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DerekNonGeneric DerekNonGeneric DerekNonGeneric approved these changes

@aduh95 aduh95 aduh95 approved these changes

@aymen94 aymen94 aymen94 approved these changes

@Lxxyx Lxxyx Lxxyx approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@Trott Trott Trott approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

doc: syntax-highlighted JSDoc comments in dark mode are low-visibility
9 participants
@Ayase-252 @DerekNonGeneric @jasnell @Trott @lpinca @cjihrig @Lxxyx @aymen94 @aduh95