Add <meta> tags for translations (#5930)

* Add site config with domain name * Add <meta> tags for languages * Move legacy redirect out of vercel config This lets us give it a more specific subdomain per lang. * Support sites with no legacy * Fix types * Undo unrelated change
doaortu · Apr 18, 2023 · a35b64c · a35b64c
1 parent 6c096e0
commit a35b64c
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 26 deletions.
diff --git a/next.config.js b/next.config.js
@@ -2,6 +2,8 @@
  * Copyright (c) Facebook, Inc. and its affiliates.
  */
 
+const siteConfig = require('./src/siteConfig').siteConfig;
+
 /**
  * @type {import('next').NextConfig}
  **/
@@ -14,6 +16,22 @@ const nextConfig = {
     legacyBrowsers: false,
     browsersListForSwc: true,
   },
+  redirects() {
+    const redirects = [];
+    const languageCode = siteConfig.languageCode;
+    const subdomain =
+      languageCode === 'en' || !siteConfig.hasLegacySite
+        ? ''
+        : languageCode + '.';
+    return [
+      {
+        // Assume all *.html links are legacy site URLs.
+        source: '/:path*(\\.html)',
+        destination: `https://${subdomain}legacy.reactjs.org/:path*.html`,
+        permanent: false,
+      },
+    ];
+  },
   env: {
     SANDPACK_BARE_COMPONENTS: process.env.SANDPACK_BARE_COMPONENTS,
   },

diff --git a/src/components/Seo.tsx b/src/components/Seo.tsx
@@ -5,6 +5,7 @@
 import * as React from 'react';
 import Head from 'next/head';
 import {withRouter, Router} from 'next/router';
+import {siteConfig} from '../siteConfig';
 
 export interface SeoProps {
   title: string;
@@ -16,6 +17,16 @@ export interface SeoProps {
   searchOrder?: number;
 }
 
+const deployedTranslations = [
+  'en',
+  // We'll add more languages when they have enough content.
+];
+
+function getDomain(languageCode: string): string {
+  const subdomain = languageCode === 'en' ? '' : languageCode + '.';
+  return subdomain + 'react.dev';
+}
+
 export const Seo = withRouter(
   ({
     title,
@@ -26,29 +37,37 @@ export const Seo = withRouter(
     isHomePage,
     searchOrder,
   }: SeoProps & {router: Router}) => {
+    const siteDomain = getDomain(siteConfig.languageCode);
+    const canonicalUrl = `https://${siteDomain}${
+      router.asPath.split(/[\?\#]/)[0]
+    }`;
     const pageTitle = isHomePage ? 'React' : title + ' – React';
     // Twitter's meta parser is not very good.
     const twitterTitle = pageTitle.replace(/[<>]/g, '');
     return (
       <Head>
-        {/* DEFAULT */}
-
         <meta name="viewport" content="width=device-width, initial-scale=1" />
-
         {title != null && <title key="title">{pageTitle}</title>}
         {description != null && (
           <meta name="description" key="description" content={description} />
         )}
-        {/* <link rel="icon" type="image/x-icon" href={favicon} />
-      <link rel="apple-touch-icon" href={favicon} />  @todo favicon */}
+        <link rel="canonical" href={canonicalUrl} />
+        <link
+          rel="alternate"
+          href={canonicalUrl.replace(siteDomain, getDomain('en'))}
+          hrefLang="x-default"
+        />
+        {deployedTranslations.map((languageCode) => (
+          <link
+            key={'alt-' + languageCode}
+            rel="alternate"
+            hrefLang={languageCode}
+            href={canonicalUrl.replace(siteDomain, getDomain(languageCode))}
+          />
+        ))}
         <meta property="fb:app_id" content="623268441017527" />
-        {/* OPEN GRAPH */}
         <meta property="og:type" key="og:type" content="website" />
-        <meta
-          property="og:url"
-          key="og:url"
-          content={`https://react.dev${router.asPath.split(/[\?\#]/)[0]}`}
-        />
+        <meta property="og:url" key="og:url" content={canonicalUrl} />
         {title != null && (
           <meta property="og:title" content={pageTitle} key="og:title" />
         )}
@@ -59,14 +78,11 @@ export const Seo = withRouter(
             content={description}
           />
         )}
-
         <meta
           property="og:image"
           key="og:image"
-          content={`https://react.dev${image}`}
+          content={`https://${siteDomain}${image}`}
         />
-
-        {/* TWITTER */}
         <meta
           name="twitter:card"
           key="twitter:card"
@@ -88,11 +104,10 @@ export const Seo = withRouter(
             content={description}
           />
         )}
-
         <meta
           name="twitter:image"
           key="twitter:image"
-          content={`https://react.dev${image}`}
+          content={`https://${siteDomain}${image}`}
         />
         <meta
           name="google-site-verification"

diff --git a/src/pages/_document.tsx b/src/pages/_document.tsx
@@ -3,11 +3,11 @@
  */
 
 import {Html, Head, Main, NextScript} from 'next/document';
+import {siteConfig} from '../siteConfig';
 
 const MyDocument = () => {
-  //  @todo specify language in HTML?
   return (
-    <Html lang="en">
+    <Html lang={siteConfig.languageCode}>
       <Head />
       <body className="font-text font-medium antialiased text-lg bg-wash dark:bg-wash-dark text-secondary dark:text-secondary-dark leading-base">
         <script

diff --git a/src/siteConfig.ts → src/siteConfig.js b/src/siteConfig.ts → src/siteConfig.js
@@ -2,8 +2,12 @@
  * Copyright (c) Facebook, Inc. and its affiliates.
  */
 
-export const siteConfig = {
-  editUrl: 'https://github.com/reactjs/react.dev/tree/main/src/pages',
+exports.siteConfig = {
+  // --------------------------------------
+  // Translations should replace these lines:
+  languageCode: 'en',
+  hasLegacySite: true,
+  // --------------------------------------
   copyright: `Copyright © ${new Date().getFullYear()} Facebook Inc. All Rights Reserved.`,
   repoUrl: 'https://github.com/facebook/react',
   twitterUrl: 'https://twitter.com/reactjs',

diff --git a/vercel.json b/vercel.json
@@ -84,11 +84,6 @@
       "destination": "/blog/2020/12/21/data-fetching-with-react-server-components",
       "permanent": false
     },
-    {
-      "source": "/:path*(\\.html)",
-      "destination": "https://legacy.reactjs.org/:path*.html",
-      "permanent": false
-    },
     {
       "source": "/tips/controlled-input-null-value.html",
       "destination": "/reference/react-dom/components/input#im-getting-an-error-a-component-is-changing-an-uncontrolled-input-to-be-controlled",