Skip to content

Conversation

hns
Copy link
Member

@hns hns commented Jul 8, 2025

Please review an enhancement to add a dark theme to javadoc-generated API documentation. There is a new button in the top right corner that brings up a menu to switch between themes. Available options are "Light", "Dark", and "System Setting" (following the system-wide theme setting). The selected theme is stored and preserved across browser sessions.

Generated docs can be viewed here (iteration 5, module java.base only).

Screenshots below show both themes and how to switch between them.

light-theme-2 dark-theme-2

Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8342705: Add dark mode for docs (Enhancement - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/26185/head:pull/26185
$ git checkout pull/26185

Update a local copy of the PR:
$ git checkout pull/26185
$ git pull https://git.openjdk.org/jdk.git pull/26185/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 26185

View PR using the GUI difftool:
$ git pr show -t 26185

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/26185.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jul 8, 2025

👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Jul 8, 2025

@hns This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8342705: Add dark mode for docs

Reviewed-by: liach

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 498 new commits pushed to the master branch:

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the rfr Pull request is ready for review label Jul 8, 2025
@openjdk
Copy link

openjdk bot commented Jul 8, 2025

@hns The following label will be automatically applied to this pull request:

  • javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@mlbridge
Copy link

mlbridge bot commented Jul 8, 2025

Webrevs

@hns
Copy link
Member Author

hns commented Jul 15, 2025

I'm finding the orange link color a bit too flashy, so I created a new snapshot that uses a pale blue color for links. This results in a less striking color scheme that is more in line with the default light theme IMO.

I also realized that there is no requirement in terms of a11y to use a particular link color for navigation links, so I switched to a neutral color for links in the subnavigation and sidebar, which further "calms" the layout and improves readability IMO.

I haven't updated the PR yet and posting this here for discussion.

body.theme-dark {
.hljs-title.function_,
.hljs-template-variable {
color: #66bcce;
Copy link
Member

Choose a reason for hiding this comment

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

I don't think you can nest rules here, the browser may skip/ignore them.

Copy link
Member Author

Choose a reason for hiding this comment

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

It works for me, I've tried it on Firefox, Safari and Chrome.

Documentation of CSS nesting: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_nesting/Using_CSS_nesting
It's implemented in all major browsers: https://caniuse.com/?search=css%20nesting

@hns
Copy link
Member Author

hns commented Jul 17, 2025

I updated the PR with changes described in my previous comment.

@hns
Copy link
Member Author

hns commented Jul 25, 2025

Another iteration on this PR, moving the theme switcher icon in line with the main navigation links in the top navigation bar.

I updated screenshots and demo docs.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Aug 19, 2025
@hns
Copy link
Member Author

hns commented Aug 19, 2025

/integrate

@openjdk
Copy link

openjdk bot commented Aug 19, 2025

Going to push as commit 0755477.
Since your change was applied there have been 498 commits pushed to the master branch:

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Aug 19, 2025
@openjdk openjdk bot closed this Aug 19, 2025
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Aug 19, 2025
@openjdk
Copy link

openjdk bot commented Aug 19, 2025

@hns Pushed as commit 0755477.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated javadoc [email protected]
Development

Successfully merging this pull request may close these issues.

3 participants