Skip to content

doc: make theme consistent across api and other docs (from nodejs.org repo) #50877

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

Merged
nodejs-github-bot merged 3 commits into from
Nov 27, 2023
Merged

doc: make theme consistent across api and other docs (from nodejs.org repo) #50877

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
802e17d
doc: make theme consistent across api and other docs
demakoff Nov 24, 2023
7f5acab
doc: update formatting
demakoff Nov 24, 2023
5604531
Update md formatting
demakoff Nov 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: make theme consistent across api and other docs 
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
  • Loading branch information
@demakoff
demakoff committed Nov 24, 2023
commit 802e17d28add6ec03f5a77f0baf6c10e262795e9
7 changes: 7 additions & 0 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,13 @@ 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
View file
Open in desktop
Original file line number Diff line number Diff line change
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
2 changes: 1 addition & 1 deletion doc/contributing/collaborator-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ 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
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.

Expand Down