{ "componentChunkName": "component---src-pages-blog-markdown-remark-fields-slug-js", "path": "/blog/nextjs-metadata", "result": {"data":{"markdownRemark":{"html":"

Imagine walking through the Van Gogh Museum, exploring different rooms that correspond to significant life moments of the illustrious and fascinating Dutch painter. 🎨

\n

Each painting is accompanied by a placard that provides crucial details about each of his works (its title, the year it was painted, and a short description). Without these, you will find yourself struggling to understand the artwork’s meaning, historical context, or significance.

\n

On the web, metadata serves a similar purpose. It provides essential information about a webpage (like its title, description, and keywords). Metadata helps search engines and social media platforms “understand” your content and present it to the right audience.

\n

Just as well-written placards enhance a museum experience, well-structured metadata improves your website’s SEO, shareability, and visibility.

\n

In Next.js, managing metadata effectively can make your site more discoverable and engaging. If you’ve ever seen or Page Title in an HTML file, you’ve encountered metadata. And just like Van Gogh’s The Starry Night, it might not change how a page looks, but it plays a crucial role behind the scenes.

\n

In this article, we’ll explore how to craft effective metadata in Next.js and ensure your site’s “placards” are as informative and compelling as possible. 🖼️🚀

\n

The first section provides a brief introduction to metadata and what it can do for you.
\nThe second section dives into how you can use Next.js for your metadata management.

\n

\"Van

\n\n \n \n \n \n
\n\n
\n

👉 Metadata Explained: How It Boosts SEO and Website Visibility

\n

Metadata is extra information that gives valuable insights into your app’s data. It summarizes basic information about your data. You can think of it as “data about your data”! 📊🔍

\n

It includes page titles, descriptions, keywords, and social media previews 📌✨ — all of which help make your web app easier to find, understand, and use.

\n

Here is an example of metadata you may have seen in the <head> tag of any HTML file:

\n\n \n The Starry Night by Vincent van Gogh \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n`, `71498705755311160000`)\"\n >\n \n \n \n \n
<head>\n    <!-- Basic Metadata -->\n    <title>The Starry Night by Vincent van Gogh</title> <!-- Sets the page title (shown in browser tab) -->\n    <meta charset=\"UTF-8\"> <!-- Defines character encoding -->\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"> <!-- Ensures responsive design -->\n    \n    <!-- SEO Metadata -->\n    <meta name=\"description\" content=\"Explore 'The Starry Night,' Vincent van Gogh's iconic masterpiece. Learn about its history, meaning, and artistic techniques.\">\n    <meta name=\"keywords\" content=\"The Starry Night, Vincent van Gogh, Impressionism, famous paintings, art history\">\n    <meta name=\"author\" content=\"Vincent van Gogh\">\n    <meta name=\"robots\" content=\"index, follow\"> <!-- Allows search engines to index the page -->\n\n    <!-- Open Graph (OG) Metadata for Social Media -->\n    <meta property=\"og:title\" content=\"The Starry Night - Vincent van Gogh\">\n    <meta property=\"og:description\" content=\"Discover the story behind 'The Starry Night,' one of Vincent van Gogh's most famous paintings.\">\n    <meta property=\"og:image\" content=\"https://example.com/starry-night.jpg\">\n    <meta property=\"og:url\" content=\"https://example.com/starry-night\">\n    <meta property=\"og:type\" content=\"article\">\n\n    <!-- Favicon -->\n    <link rel=\"icon\" type=\"image/png\" href=\"starry-night-favicon.png\">\n</head>
\n

Why Metadata is Important

\n

Metadata is vital for search engines to rank your content and enhance SEO.

\n

Proper metadata configuration enhances SEO by:

\n
    \n
  • Improving Search Engine Rankings: Accurate titles and descriptions help search engines understand page content.
    • \n
  • Optimizing Social Media Sharing: Open Graph metadata ensures rich previews when links are shared.
    • \n
  • Increasing Click-Through Rates: Compelling metadata can attract users to click on your links in search results.
    • \n
\n

Types of Metadata

\n

There are various types of metadata. Some common ones, that you will encounter often, are title, description, keywords, open graph, and favicon.

\n

Title Metadata

\n

The title metadata defines the title of a webpage shown on the browser tab and in search engine results.

\nPage Title`, `28243161377403080000`)\"\n >\n \n \n \n \n
<title>Page Title</title>
\n

Description Metadata

\n

The description metadata provides a summary of the webpage content, which is crucial for SEO. The description property corresponds to the meta tag in the head section of the document.

\n`, `59258287072572880000`)\"\n >\n \n \n \n \n
<meta name=\"description\" content=\"A brief description of the page content.\" />
\n

Keyword Metadata

\n

The keyword metadata includes keywords related to the webpage content, aiding in search engine indexing.

\n`, `5731973858585060000`)\"\n >\n \n \n \n \n
<meta name=\"keywords\" content=\"keyword1, keyword2, keyword3\" />
\n

Open Graph Metadata

\n

The Open Graph metadata (part of the Open Graph protocol) enhances the presentation of web pages on social media platforms by specifying details like title, description, and preview images. They are used by Facebook, X (formerly Twitter), LinkedIn, Discord, Slack, and others.

\n

The Open Graph protocol specifies the different types of meta tags that you can use to describe your data.

\n\n\n\n`, `33886847639105876000`)\"\n >\n \n \n \n \n
<meta property=\"og:title\" content=\"Title Here\" />\n<meta property=\"og:description\" content=\"Description Here\" />\n<meta property=\"og:image\" content=\"image_url_here\" />\n<meta property=\"og:url\" content=\"https://imgsrc.io/guides/open-graph-meta-tags\" />
\n

Favicon Metadata

\n

The favicon metadata links the favicon to the webpage, displayed in the browser’s address bar or tab.

\n`, `67564367717253005000`)\"\n >\n \n \n \n \n
<link rel=\"icon\" href=\"path/to/favicon.ico\" />
\n

🌟 Next.js Metadata for SEO: Best Practices and Implementation

\n

Next.js has a Metadata API that is used to define and manage your app’s metadata.
It allows you to modify the <head> element of a page.

\n
\n

🗂️ Metadata management helps users easily access and understand data (what it means, where it comes from, how it’s structured, how it connects to other data, and any usage rules).

\n
\n

🏗️ Metadata Inheritance and Overriding

\n

Next.js organizes metadata in a hierarchy, ensuring consistency while allowing pages to set their own unique details.

\n

đź”— How Metadata Inheritance Works

\n

To keep things organized, Next.js allows you to set global metadata for your entire site while letting individual pages override or extend it when needed. This ensures consistency, giving each page the flexibility to have its own unique details. 🚀

\n
Global Metadata (Applied to All Pages)
\n

Set in layout.js:

\n\n \n \n \n \n
export const metadata = {\n  title: \"My Website\",\n  description: \"A great website built with Next.js\",\n};
\n
Page-Specific Metadata (Overrides Global Values)
\n

Set in page.js:

\n\n \n \n \n \n
export const metadata = {\n  title: \"About Us - My Website\", // Overrides global title\n  description: \"Learn more about our team and mission.\", // Overrides global description\n};
\n

The output in the <head> section for the About page will be:

\nAbout Us - My Website\n`, `52996177392036545000`)\"\n >\n \n \n \n \n
<title>About Us - My Website</title>\n<meta name=\"description\" content=\"Learn more about our team and mission.\">
\n

Summary:

\n
    \n
  • Root Layout Metadata: Define a default structure in the main layout (layout.js).
    • \n
  • Nested Layouts: Override or extend metadata for specific sections of the site.
    • \n
  • Page Metadata: Each page can refine or replace metadata as needed.
    • \n
\n
\n

Adding Metadata In Your Next.js App

\n

There are two ways to add metadata to your app, config-based and file-based metadata.
Both methods help manage SEO-related information like page titles, descriptions, and Open Graph tags.

\n

Below is a detailed guide on how to utilize both options effectively.

\n

Config-Based Metadata

\n

Config-based metadata is added in layout.js or page.js by using a static metadata object or a dynamic generateMetadata() function.

\n
Configuring Static Metadata
\n

Static Metadata is predefined and remains constant across sessions. To implement static metadata in Next.js:

\n\n \n \n \n \n
export const metadata = {\n    title: ' ... ', \n    description: ' ... ',\n}\n\nexport default function Page() {}
\n

This setup ensures that all pages inheriting from this layout share the same metadata.

\n
Configuring Dynamic Metadata
\n

Dynamic metadata adapts based on content or user interaction.\nYou can use the generateMetadata function to fetch metadata that requires dynamic values.

\n

To configure dynamic metadata:

\n res.json())\n\n // optionally access and extend (rather than replace) parent metadata\n const previousImage = (await parent).openGraph?.images || []\n\n return {\n title: product.title,\n openGraph: {\n images: ['/some-specific-page-image.jpg', ...previousImages],\n },\n }\n}\n\nexport default function Page({ params, searchParams }) {}`, `20447198901390262000`)\"\n >\n \n \n \n \n
export async function generateMetadata({ params, searchParams }, parent) {\n    // read route params\n    const id = (await params).id\n\n    // fetch data\n    const product = await fetch(`https://.../${id}`).then((res) => res.json())\n\n    // optionally access and extend (rather than replace) parent metadata\n    const previousImage = (await parent).openGraph?.images || []\n\n    return {\n        title: product.title,\n        openGraph: {\n            images: ['/some-specific-page-image.jpg', ...previousImages],\n        },\n    }\n}\n\nexport default function Page({ params, searchParams }) {}
\n

This approach is beneficial for pages where metadata depends on dynamic data, such as product details or user-generated content.

\n

File-Based Metadata

\n

File-based metadata is added in special metadata files in your project’s folders, either statically or dynamically:

\n
    \n
  • favicon.ico, apple-icon.jpg, and icon.jpg
    • \n
  • opengraph-image.jpg and twitter-image.jpg
    • \n
  • robots.txt
    • \n
  • sitemap.xml
    • \n
\n
🖼️ favicon.ico, apple-icon.jpg, and icon.jpg
\n

The favicon.ico, apple-icon.jpg, and icon.jpg files are used to provide your website with consistent branding across different platforms and devices.

\n
    \n
  • favicon.ico is the small icon that appears in the browser tab.
    • \n
  • apple-icon.jpg is used for the home screen icon on iOS devices.
    • \n
  • icon.jpg is used for a more general icon that can appear across other platforms, like Android or web apps.
    • \n
\n

Here’s how to include them in your Next.js project:

\n\n\n\n\n\n\n\n`, `53463951664942514000`)\"\n >\n \n \n \n \n
<!-- Favicon for browsers -->\n<link rel=\"icon\" href=\"https://example.com/favicon.ico\" type=\"image/x-icon\">\n\n<!-- Apple icon for iOS devices -->\n<link rel=\"apple-touch-icon\" href=\"https://example.com/apple-icon.jpg\">\n\n<!-- General icon for web apps -->\n<link rel=\"icon\" href=\"https://example.com/icon.jpg\" type=\"image/jpg\">
\n

In Next.js, you can define these dynamically in the _document.js file:

\n\n \n \n \n \n \n \n
\n \n \n \n );\n }\n}\n\nexport default MyDocument;`, `46352825043132320000`)\"\n >\n \n \n \n \n
import Document, { Html, Head, Main, NextScript } from 'next/document';\n\nclass MyDocument extends Document {\n  render() {\n    return (\n      <Html>\n        <Head>\n          <link rel=\"icon\" href=\"https://example.com/favicon.ico\" type=\"image/x-icon\" />\n          <link rel=\"apple-touch-icon\" href=\"https://example.com/apple-icon.jpg\" />\n          <link rel=\"icon\" href=\"https://example.com/icon.jpg\" type=\"image/jpg\" />\n        </Head>\n        <body>\n          <Main />\n          <NextScript />\n        </body>\n      </Html>\n    );\n  }\n}\n\nexport default MyDocument;
\n

These icons help brand your website and ensure that it looks great on all devices and in every browser tab.

\n
đź“· opengraph-image.jpg and twitter-image.jpg
\n

The opengraph-image.jpg and twitter-image.jpg files are used to set the preview image when your content is shared on social media platforms like Facebook and X (previously Twitter). These images provide a visual representation of your page, making it more engaging and clickable.

\n

For Open Graph (OG) and X/Twitter Cards, you would typically add the following metadata:

\n\n\n\n\n`, `43329722462480330000`)\"\n >\n \n \n \n \n
<!-- Open Graph Metadata -->\n<meta property=\"og:image\" content=\"https://example.com/opengraph-image.jpg\">\n\n<!-- Twitter Card Metadata -->\n<meta name=\"twitter:image\" content=\"https://example.com/twitter-image.jpg\">
\n

In Next.js, you can define these dynamically using a function:

\n\n \n \n \n \n \n );\n}\n\n// Output:\n\n// \n// `, `67438241321548186000`)\"\n >\n \n \n \n \n
export default function Page() {\n  const ogImage = 'https://example.com/opengraph-image.jpg';\n  const twitterImage = 'https://example.com/twitter-image.jpg';\n\n  return (\n    <>\n      <Head>\n        <meta property=\"og:image\" content={ogImage} />\n        <meta name=\"twitter:image\" content={twitterImage} />\n      </Head>\n    </>\n  );\n}\n\n// Output:\n\n// <meta property=\"og:image\" content=\"https://example.com/opengraph-image.jpg\">\n// <meta name=\"twitter:image\" content=\"https://example.com/twitter-image.jpg\">
\n

These images help ensure that when your page is shared on social media, it has a beautiful, relevant preview that attracts attention!

\n
🤖 robots.txt
\n

The robots.txt file tells search engine crawlers which URLs they can access on your site and looks something like this:

\n\n \n \n \n \n
User-Agent: *\nAllow: /\nDisallow: /private/\nSitemap: https://example.com/sitemap.xml
\n

In Next.js, you can either write your file like the above example (static) or generate it (dynamic) in a robots.js/.ts file.

\n\n \n \n \n \n
export default function robots() {\n  return {\n    rules: {\n      userAgent: '*',\n      allow: '/',\n      disallow: '/private/',\n    },\n    sitemap: 'https://example.com/sitemap.xml',\n  }\n}\n\n// Output:\n\n// User-Agent: *\n// Allow: /\n// Disallow: /private/\n// Sitemap: https://example.com/sitemap.xml
\n
🗺️ sitemap.xml
\n

The sitemap.xml file provides search engines with a structured map of all the important pages on your site, helping them crawl and index your content more efficiently. It looks something like this:

\n\n\n \n https://example.com/\n 2025-03-01\n 1.0\n \n \n https://example.com/about\n 2025-02-15\n 0.8\n \n`, `6819126049741220000`)\"\n >\n \n \n \n \n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n  <url>\n    <loc>https://example.com/</loc>\n    <lastmod>2025-03-01</lastmod>\n    <priority>1.0</priority>\n  </url>\n  <url>\n    <loc>https://example.com/about</loc>\n    <lastmod>2025-02-15</lastmod>\n    <priority>0.8</priority>\n  </url>\n</urlset>
\n

In Next.js, you can create a static sitemap.xml file or generate it dynamically. Here’s how to generate it dynamically:

\n\n// \n// \n// https://example.com/\n// 2025-03-01\n// 1.0\n// \n// \n// https://example.com/about\n// 2025-02-15\n// 0.8\n// \n// `, `81783650806462680000`)\"\n >\n \n \n \n \n
export default function sitemap() {\n  return [\n    {\n      url: 'https://example.com/',\n      lastModified: '2025-03-01',\n      priority: 1.0,\n    },\n    {\n      url: 'https://example.com/about',\n      lastModified: '2025-02-15',\n      priority: 0.8,\n    },\n  ]\n}\n\n// Output:\n\n// <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n// <urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n//   <url>\n//     <loc>https://example.com/</loc>\n//     <lastmod>2025-03-01</lastmod>\n//     <priority>1.0</priority>\n//   </url>\n//   <url>\n//     <loc>https://example.com/about</loc>\n//     <lastmod>2025-02-15</lastmod>\n//     <priority>0.8</priority>\n//   </url>\n// </urlset>
\n

This helps search engines discover and index all your important pages!

\n

Best Practices for Metadata Management đź“Ś

\n

To maximize the benefits of metadata management in Next.js (and metadata management in general), here are a few best practices to keep in mind:

\n
    \n
  • Keep metadata concise and relevant: Ensure titles and descriptions are clear and to the point.
    • \n
  • Utilize dynamic metadata when necessary: For pages with content that changes frequently, implement dynamic metadata to reflect the current state.
    • \n
  • Leverage metadata templates: Use title templates to maintain consistency across pages.
    • \n
  • Regularly update metadata: Keep metadata current to reflect any changes in content or branding.
    • \n
  • Properly set Open Graph: Set Open Graph metadata correctly to improve how your content looks on social media, to boost engagement and clicks.
    • \n
\n

Conclusion 🎯

\n

Effective metadata management in Next.js is vital for SEO and user engagement. By understanding and implementing both static and dynamic metadata, leveraging inheritance, and following best practices, you can create apps that are both user-friendly and search-engine optimized.

\n

To deepen your Next.js knowledge, check out our article “Securing your Next.js with Authentication”. It covers how Next.js handles rendering and authentication, explores various authentication strategies, and guides you through implementing an authentication solution in Next.js.

","frontmatter":{"date":"February 27, 2025","title":"Metadata in Next.js: Enhancing SEO and User Experience","cover":"metadata-in-nextjs.png","author":"Maria Shimkovska","description":"Learn how to effectively manage metadata in Next.js to boost SEO and improve user engagement through static and dynamic configurations."},"fields":{"slug":"/nextjs-metadata/"}},"site":{"siteMetadata":{"title":"SuperTokens Blog"}}},"pageContext":{"id":"e589d40c-8841-55cc-8be1-58e0e23754b0","fields__slug":"/nextjs-metadata/","__params":{"fields__slug":"nextjs-metadata"}}}, "staticQueryHashes": []}