Adding SEO to Remix - How to manage SEO on Remix

Remix Blog

Words are nice... but code speaks louder. Dive into a fully commented project template, showcasing these techniques (and more) in action.

Remix > Adding SEO to pages

Adding SEO to pages

Similarly to what we offer with responsive images, our GraphQL API also offers a way to fetch pre-computed meta tags based on the content you insert inside DatoCMS.

Here's a sample of the meta tags you can automatically generate. It includes meta tags for SEO, social share and website favicons:

1
<title>DatoCMS Blog - DatoCMS</title>
2
<meta property="og:title" content="DatoCMS Blog" />
3
<meta name="twitter:title" content="DatoCMS Blog" />
4
<meta name="description" content="Lorem ipsum..." />
5
<meta property="og:description" content="Lorem ipsum..." />
6
<meta name="twitter:description" content="Lorem ipsum..." />
7
<meta property="og:image" content="https://www.datocms-assets.com/..." />
8
<meta property="og:image:width" content="2482" />
9
<meta property="og:image:height" content="1572" />
10
<meta name="twitter:image" content="https://www.datocms-assets.com/..." />
11
<meta property="og:locale" content="en" />
12
<meta property="og:type" content="website" />
13
<meta property="og:site_name" content="DatoCMS" />
14
<meta property="article:modified_time" content="2020-03-06T15:07:14Z" />
15
<meta name="twitter:card" content="summary" />
16
<meta name="twitter:site" content="@datocms" />
17
<link sizes="16x16" type="image/png" rel="icon" href="https://www.datocms-assets.com/..." />
18
<link sizes="32x32" type="image/png" rel="icon" href="https://www.datocms-assets.com/..." />
19
<link sizes="96x96" type="image/png" rel="icon" href="https://www.datocms-assets.com/..." />
20
<link sizes="192x192" type="image/png" rel="icon" href="https://www.datocms-assets.com/..." />

You can easily include all this information inside your Remix app with the help of our react-datocms package, so make sure to install it, if you've not already done it:

npm i --save react-datocms

Adding SEO and social share meta tags

With Remix, you can specify meta tags for a page using the meta export:

export function meta({ data }) {
    title: "Something cool",
    description: "This becomes the nice preview on search results."
  };
};

With DatoCMS you can feed content coming from a _seoMetaTags query directly into Remix by using the toRemixMeta function, which generates a compatible object for Remix's meta function:

1
import { request } from "../lib/datocms";
2
import { toRemixMeta } from "react-datocms";
3
import { useLoaderData } from "remix";
4

5
const HOMEPAGE_QUERY = `
6
  {
7
    blog {
8
      seo: _seoMetaTags {
9
        attributes
10
        content
11
        tag
12
      }
13
    }
14
  }`;
15

16
export async function loader() {
17
  return request(HOMEPAGE_QUERY, {
18
    variables: { limit: 10 }
19
  });
20
}
21

22
export function meta({ data }) {
23
  return toRemixMeta(data.blog.seo);
24
};
25

26

27
export default function Home() {
28
  // ...
29
}

Adding favicon links and meta tags

If you want to add all the link and meta tags needed to generate favicons for your website, you can use the renderMetaTags helper along with the faviconMetaTags GraphQL query:

Why not using the links export?

Remix offers a links export to define which <link> elements to add to the page, but for performance reasons it doesn't receive any loader data, so you cannot use it to render favicons meta tags! The best way to render them is using renderMetaTags in your root component, like in the example.

1
import {
2
  Links,
3
  LiveReload,
4
  Meta,
5
  Form,
6
  Outlet,
7
  Scripts,
8
  ScrollRestoration,
9
  useLoaderData,
10
} from 'remix';
11
import { renderMetaTags } from 'react-datocms';
12
import { load } from '~/lib/datocms';
13

14
export const loader = async ({ request }) => {
15
  return load(`
16
    {
17
      site: _site {
18
        favicon: faviconMetaTags(variants: [icon, msApplication, appleTouchIcon]) {
19
          attributes
20
          content
21
          tag
22
        }
23
      }
24
    }
25
  `);
26
};
27

28
export default function App() {
29
  const { site } = useLoaderData();
30

31
  return (
32
    <html lang="en">
33
      <head>
34
        <meta charSet="utf-8" />
35
        <meta name="viewport" content="width=device-width,initial-scale=1" />
36
        <Meta />
37
        <Links />
38
        {renderMetaTags(site.favicon)}
39
      </head>
40
      <body>
41
        <Outlet />
42
        <ScrollRestoration />
43
        <Scripts />
44
        {process.env.NODE_ENV === 'development' && <LiveReload />}
45
      </body>
46
    </html>
47
  );
48
}

Want to know more about SEO customization in DatoCMS? Check out this video tutorial:

Working with and customizing SEO Fields

Play video »