fine-tune apidocs markup for dark mode #338
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/M
|
Thanks. |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tengqm, xrstf The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
@tengqm Thanks a lot for your super quick reviews on all these PRs, it's really appreciated :-) Is there anything else I need to do to complete this? The markup on https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/ is still the old one, but the new CSS/JS is already live. |
|
@xrstf I've sent a PR refreshing the HTML (kubernetes/website#43139) and it has been merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the result of working a bit more on the dark mode for the apidocs. I had to extend the markup a bit, now at least the result is now pretty:
I adopted the font that is used on kubernetes.io, plus the colors in light mode were adjusted a bit to better match the Kubernetes website.
The markup is now also setup for an CSS-only automatic dark mode, which avoids the previous flash-of-white before the JS kicked in and applied the theme-dark class.
I also renamed the scroll-apiref.js, since the file is not just responsible for the scrolling behaviour, but also the dark mode toggler. I hope this won't cause issues when the website repo PR is eventually merged.