Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`inlineScripts inline javascript for default options 1`] = `
"(function() {
function getSystemColorMode() {
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
}
function getQueryStringTheme() {
try {
return new URLSearchParams(window.location.search).get('docusaurus-theme')
} catch (e) {}
}
function getStoredTheme() {
try {
return window['localStorage'].getItem('theme');
} catch (err) {}
}
var initialTheme = getQueryStringTheme() || getStoredTheme();
document.documentElement.setAttribute('data-theme', initialTheme || 'light');
document.documentElement.setAttribute('data-theme-choice', initialTheme || 'light');
})();"
`;

exports[`inlineScripts inline javascript for prefers color scheme and no switch 1`] = `
"(function() {
function getSystemColorMode() {
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
}
var initialTheme;
document.documentElement.setAttribute('data-theme', initialTheme || getSystemColorMode());
document.documentElement.setAttribute('data-theme-choice', initialTheme || 'system');
})();"
`;
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

import {getThemeInlineScript} from '../inlineScripts';

describe('inlineScripts', () => {
it('inline javascript for default options', () => {
expect(
getThemeInlineScript({
colorMode: {
disableSwitch: false,
defaultMode: 'light',
respectPrefersColorScheme: false,
},
siteStorage: {
type: 'localStorage',
namespace: '',
},
}),
).toMatchSnapshot();
});

it('inline javascript for prefers color scheme and no switch', () => {
expect(
getThemeInlineScript({
colorMode: {
disableSwitch: true,
defaultMode: 'light',
respectPrefersColorScheme: true,
},
siteStorage: {
type: 'localStorage',
namespace: '',
},
}),
).toMatchSnapshot();
});
});
1 change: 0 additions & 1 deletion packages/docusaurus-theme-classic/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ export default function themeClassic(
{
tagName: 'svg',
attributes: {
xmlns: 'http://www.w3.org/2000/svg',
style: 'display: none;',
},
innerHTML: SvgSpriteDefs,
Expand Down
47 changes: 27 additions & 20 deletions packages/docusaurus-theme-classic/src/inlineScripts.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const ThemeQueryStringKey = 'docusaurus-theme';
const DataQueryStringPrefixKey = 'docusaurus-data-';

export function getThemeInlineScript({
colorMode: {defaultMode, respectPrefersColorScheme},
colorMode: {disableSwitch, defaultMode, respectPrefersColorScheme},
siteStorage,
}: {
colorMode: ThemeConfig['colorMode'];
Expand All @@ -25,28 +25,35 @@ export function getThemeInlineScript({
// Make sure the key is the same as the one in the color mode React context
// Currently defined in: `docusaurus-theme-common/src/contexts/colorMode.tsx`
const themeStorageKey = `theme${siteStorage.namespace}`;
const isThemeUserConfigurable = !disableSwitch;

/* language=js */
return `(function() {
var defaultMode = '${defaultMode}';
var respectPrefersColorScheme = ${respectPrefersColorScheme};
function getSystemColorMode() {
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
}
function getQueryStringTheme() {
try {
return new URLSearchParams(window.location.search).get('${ThemeQueryStringKey}')
} catch (e) {}
}
function getStoredTheme() {
try {
return window['${siteStorage.type}'].getItem('${themeStorageKey}');
} catch (err) {}
}
var initialTheme = getQueryStringTheme() || getStoredTheme();
document.documentElement.setAttribute('data-theme', initialTheme || (respectPrefersColorScheme ? getSystemColorMode() : defaultMode));
document.documentElement.setAttribute('data-theme-choice', initialTheme || (respectPrefersColorScheme ? 'system' : defaultMode));
})();`;
function getSystemColorMode() {
return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
}
${
isThemeUserConfigurable
? ` function getQueryStringTheme() {
try {
return new URLSearchParams(window.location.search).get('${ThemeQueryStringKey}')
} catch (e) {}
}
function getStoredTheme() {
try {
return window['${siteStorage.type}'].getItem('${themeStorageKey}');
} catch (err) {}
}
var initialTheme = getQueryStringTheme() || getStoredTheme();`
: ' var initialTheme;'
}
document.documentElement.setAttribute('data-theme', initialTheme || ${
respectPrefersColorScheme ? 'getSystemColorMode()' : `'${defaultMode}'`
});
document.documentElement.setAttribute('data-theme-choice', initialTheme || ${
respectPrefersColorScheme ? `'system'` : `'${defaultMode}'`
});
})();`;
}

/* language=js */
Expand Down
12 changes: 10 additions & 2 deletions website/src/pages/versions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import Translate from '@docusaurus/Translate';
import {
useVersions,
useLatestVersion,
type GlobalVersion,
} from '@docusaurus/plugin-content-docs/client';
import Layout from '@theme/Layout';
import Heading from '@theme/Heading';
Expand Down Expand Up @@ -49,6 +50,13 @@ export default function Version(): ReactNode {
);
const repoUrl = `https://github.com/${organizationName!}/${projectName!}`;

function getReleaseNotesUrl(version: GlobalVersion): string {
if (version.name === '2.x') {
return 'https://github.com/facebook/docusaurus/blob/main/CHANGELOG-v2.md';
}
return `${repoUrl}/releases/tag/v${version.name}`;
}

return (
<Layout
title="Versions"
Expand Down Expand Up @@ -81,7 +89,7 @@ export default function Version(): ReactNode {
</Link>
</td>
<td>
<Link to={`${repoUrl}/releases/tag/v${latestVersion.name}`}>
<Link to={getReleaseNotesUrl(latestVersion)}>
<ReleaseNotesLabel />
</Link>
</td>
Expand Down Expand Up @@ -142,7 +150,7 @@ export default function Version(): ReactNode {
</Link>
</td>
<td>
<Link href={`${repoUrl}/releases/tag/v${version.name}`}>
<Link href={getReleaseNotesUrl(version)}>
<ReleaseNotesLabel />
</Link>
</td>
Expand Down
Loading