Skip to content

Commit

Permalink
doc: make theme consistent across api and other docs
Browse files Browse the repository at this point in the history
Since website based on 2 different repos, there was an inconsistency
in theme selection, so we had 2 independant theme props.
Now only one stored in local storage is a single source of truth

PR-URL: #50877
Reviewed-By: Claudio Wunder <cwunder@gnome.org>
Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io>
  • Loading branch information
demakoff authored and UlisesGascon committed Dec 19, 2023
1 parent f94a24c commit 032535e
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 10 deletions.
6 changes: 6 additions & 0 deletions BUILDING.md
Expand Up @@ -462,6 +462,12 @@ make docopen
This will open a file URL to a one-page version of all the browsable HTML
documents using the default browser.

```bash
make docclean
```

This will clean previously built doc.

To test if Node.js was built correctly:

```bash
Expand Down
14 changes: 7 additions & 7 deletions doc/api_assets/api.js
Expand Up @@ -2,11 +2,11 @@

{
function setupTheme() {
const kCustomPreference = 'customDarkTheme';
const userSettings = sessionStorage.getItem(kCustomPreference);
const storedTheme = localStorage.getItem('theme');
const themeToggleButton = document.getElementById('theme-toggle-btn');

if (userSettings === null && window.matchMedia) {
// Follow operating system theme preference
if (storedTheme === null && window.matchMedia) {
const mq = window.matchMedia('(prefers-color-scheme: dark)');

if ('onchange' in mq) {
Expand All @@ -28,16 +28,16 @@
if (mq.matches) {
document.documentElement.classList.add('dark-mode');
}
} else if (userSettings === 'true') {
} else if (storedTheme === 'dark') {
document.documentElement.classList.add('dark-mode');
}

if (themeToggleButton) {
themeToggleButton.hidden = false;
themeToggleButton.addEventListener('click', function() {
sessionStorage.setItem(
kCustomPreference,
document.documentElement.classList.toggle('dark-mode'),
localStorage.setItem(
'theme',
document.documentElement.classList.toggle('dark-mode') ? 'dark' : 'light',
);
});
}
Expand Down
7 changes: 4 additions & 3 deletions doc/contributing/collaborator-guide.md
Expand Up @@ -532,9 +532,10 @@ The TSC serves as the final arbiter where required.
[build](https://github.com/nodejs/build/issues) repositories, open new
issues. Run a new CI any time someone pushes new code to the pull request.
4. Check that the commit message adheres to [commit message guidelines][].
5. Add all necessary [metadata](#metadata) to commit messages before landing. If
you are unsure exactly how to format the commit messages, use the commit log
as a reference. See [this commit][commit-example] as an example.
5. Add all necessary [metadata][git-node-metadata] to commit messages before
landing. If you are unsure exactly how to format the commit messages, use
the commit log as a reference. See [this commit][commit-example] as an
example.

For pull requests from first-time contributors, be
[welcoming](#welcoming-first-time-contributors). Also, verify that their git
Expand Down

0 comments on commit 032535e

Please sign in to comment.