Skip to content
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

Jump to bottom

feat(theme): add support for meta og locale and alternates #9152

Merged
merged 3 commits into from
Jul 28, 2023
Merged

feat(theme): add support for meta og locale and alternates #9152

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4716be0
feat(core): generate meta og locale and alternates
FlorinaPacurar Jul 17, 2023
f4de5a6
fix: move og:locale code to classic theme instead of defaults
FlorinaPacurar Jul 28, 2023
1fac61f
fix: chore: address minor PR feedback
FlorinaPacurar Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 24 additions & 1 deletion packages/docusaurus-theme-classic/src/theme/SiteMetadata/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,19 @@ import SearchMetadata from '@theme/SearchMetadata';
// See https://github.com/facebook/docusaurus/issues/3317
function AlternateLangHeaders(): JSX.Element {
const {
i18n: {defaultLocale, localeConfigs},
i18n: {currentLocale, defaultLocale, localeConfigs},
} = useDocusaurusContext();
const alternatePageUtils = useAlternatePageUtils();

const currentHtmlLang = localeConfigs[currentLocale]!.htmlLang;

// HTML lang is a BCP 47 tag, but the Open Graph protocol requires
// using underscores instead of dashes.
// See https://ogp.me/#optional
// See https://en.wikipedia.org/wiki/IETF_language_tag)
const bcp47ToOpenGraphLocale = (code: string): string =>
code.replace('-', '_');

// Note: it is fine to use both "x-default" and "en" to target the same url
// See https://www.searchviu.com/en/multiple-hreflang-tags-one-url/
return (
Expand All @@ -51,6 +60,20 @@ function AlternateLangHeaders(): JSX.Element {
})}
hrefLang="x-default"
/>

<meta
property="og:locale"
content={bcp47ToOpenGraphLocale(currentHtmlLang)}
/>
{Object.values(localeConfigs)
.filter((config) => currentHtmlLang !== config.htmlLang)
.map((config) => (
<meta
key={`meta-og-${config.htmlLang}`}
property="og:locale:alternate"
content={bcp47ToOpenGraphLocale(config.htmlLang)}
/>
))}
</Head>
);
}
Expand Down