Metadata helps search engines index the content of a web page and helps users to find what they are looking for. Next.js 13 introduced new APIs which help developers to improve SEO in very simple ways. In this article, we are going to learn to define metadata in Next.js applications using meta files.
Metadata provides information about web pages. It is not visible to the user but works behind the scenes, embedded in HTML usually within <head> element. This hidden information is crucial for search engines to index the content of the web page. Proper metadata increases the chances of higher ranking.
Some common metadata types include
- Title: Title of the webpage displayed in a browser tab.
<title>Title</title>
- Description: Brief overview of webpage content.
<meta name="description" content="This is a brief description of my webpage.">
- Author: Author of the webpage generally used to give credit to the author.
<meta name="author" content="Sarthak Roy">
- Date: Specified when webpage was last modified.
<meta name="date" content="2024-11-05T14:30:00+02:00">
- Keywords: Comma seperated keywords related to webpage that search engines to index the content.
<meta name="keywords" content="Next.js, React, GeeksforGeeks">
- Favicon: Small image displayed in browser tab.
- Search Engine Optimisation: Metadata helps search engines understand the content of website which helps search engines to index the website.
- Classify data: Metadata tags such as Title, Author, Publication date etc helps to classify data which make it easier for search engines to find important data especially from large websites.
- Social media integration: Metadata is essential for social media platforms because it provides important data about the content of website. Preview images are also a form of metadata that increases engagement rate.
Next.js 13 introduced new metadata APIs that makes it really easy and intuitive to add metadata to webpages. There are two ways to add metadata:
- Config-based: Export a static metadata object or a dynamic generateMetadata function from layout.(jsx | tsx) or page.(jsx | tsx).
- File-based: Next.js has special files that is used to generate meta data.
We are only going to discuss about file based method in this article.
Next.js offers special files to define metadata for webpage:
- favicon.ico, apple-icon.jpg and icon.jpg: Utilised for favicons and icons
- opengraph-image.jpg and twitter-image.jpg: Utilised for social media images.
- robot.txt: Provides instructions for search engine crowling.
- sitemap.xml: Offers informatipn about website's structure. we can programmatically generate using javascript.
- manifest.json: Used for meta data in every website extension.
Setting up Next.js project
Now its time to get started with coding. I am going to use pnpm and TypeScript for this demo but it is completely optional. Use the following command to initialise a new Next.js project in you desired directory.
pnpm create next-app@latest
Start the dev server:
pnpm dev
Now we are going to use metadata files to define metadata for our websites.
Favicon
Import your desired image inside app directory and rename it to favicon.ico. This should be enough to change the favicon of the webpage.
You can also define apple-icon.(jpg | jgeg | png) and icon.(jpg | jpeg | png | svg | ico) in the same way.
New faviconOpengraph-image and twitter-image
Add an opengraph-image.(jpg|jpeg|png|gif) and twitter-image.(jpg|jpeg|png|gif) image file to any route segment.
Add (opengraph-image | twitter-image).alt.txt to display text content when image can not be loaded.
robot.txt
It is a text file that provides instructions to web crawlers, on how to crawl and index a website.
Add robot.(js | ts) in app directory. Next.js will generate robot.txt from it.
JavaScript
import { MetadataRoute } from 'next'
export default function robots(): MetadataRoute.Robots {
return {
rules: {
userAgent: '*',
allow: '/',
disallow: '/admin/',
},
sitemap: 'https://aokura.site/sitemap.xml',
}
}
Sitemap
In Next.js sitemap.(xml | js | ts) is special file that is used to generate sitemap for the web application.
We can going to generate sitemap using sitmap.(js | ts).
JavaScript
import { MetadataRoute } from 'next'
export default function sitemap(): MetadataRoute.Sitemap {
return [
{
url: `https://my-site.com/`,
lastModified: new Date(),
changeFrequency: 'daily',
priority: 1,
},
{
url: `https://my-site.com/updates`,
lastModified: new Date(),
changeFrequency: 'weekly',
priority: 0.6,
},
{
url: `https://my-site.com/achievements`,
lastModified: new Date(),
changeFrequency: 'monthly',
priority: 0.7,
}
]
}
We can view the generated sitemap in /sitemap.xml route.
We can use generateSitemaps function for generating multiple sitemaps for the application. Let us see an example from Next.js docs
JavaScript
import { BASE_URL } from '@/app/lib/constants'
export async function generateSitemaps() {
/* Fetch the total number of products
and calculate the number of sitemaps needed
*/
return [{ id: 0 }, { id: 1 }, { id: 2 }, { id: 3 }]
}
export default async function sitemap({
id,
}: {
id: number
}): Promise<MetadataRoute.Sitemap> {
// Google's limit is 50,000 URLs per sitemap
const start = id * 50000
const end = start + 50000
const products = await getProducts(
`SELECT id, date FROM products WHERE id BETWEEN ${start} AND ${end}`
)
return products.map((product) => ({
url: `${BASE_URL}/product/${product.id}`,
lastModified: product.date,
}))
}
We can export metadata function from layout.tsx or page.tsx to set static metadata.
JavaScript
import type { Metadata } from 'next'
export const metadata: Metadata = {
title: 'My website',
description: 'Metadata demo',
keywords: []
}
export default function Page() { }
We can export special generateMetadata function which fetches dynamic metadata.
JavaScript
export async function generateMetadata(
{ params }: { params: { id: string } },
parent: ResolvingMetadata
): Promise<Metadata> {
const id = params.id;
const { data } = await axios.get < ProjectType > (`${server}/projects/${id}`);
const previousImages = (await parent).openGraph?.images || [];
return {
title: data.title,
keywords: [
data.category,
data.title,
],
openGraph: {
images: [data.image, ...previousImages],
},
};
}
Conclusion
Next.js provides easy to use powerful APIs to define metadata. In this article we have learnt about how to add favicon, opengraph and twitter images, robot.txt and sitemap in Next.js application.
Similar Reads
Next.js Tutorial Next.js is a popular React framework that extends React's capabilities by providing powerful tools for server-side rendering, static site generation, and full-stack development. It is widely used to build SEO-friendly, high-performance web applications easily.Built on React for easy development of f
6 min read
Next js basics
Next.js IntroductionNext.js is a powerful and flexible React framework that has quickly become popular among developers for building server-side rendered and static web applications. Created by Vercel, Next.js simplifies the process of developing modern web applications with its robust feature set. In this article, we’
5 min read
Getting Started with Next JSNextJS is an open-source React framework for building full-stack web applications ( created and maintained by Vercel ). You can use React Components to build user interfaces, and NextJS for additional features and optimizations. It is built on top of Server Components, which allows you to render ser
9 min read
Next.js InstallationNext.js is a popular React framework that enables server-side rendering and static site generation. It is easy to learn if you have prior knowledge of HTML, CSS, JavaScript, and ReactJS. Installing Next.js involves setting up Node.js and npm, creating a new Next.js project using npx create-next-appa
4 min read
NextJS 14 Folder StructureNext.js, a powerful React framework developed by Vercel, continues to evolve, bringing new features and improvements with each release. Version 14 of Next.js introduces enhancements to the folder structure, making it more efficient for developers to organize their projects. In this article, we’ll ex
4 min read
Next.js Create Next AppIn Next.js, the create next app command is used to automatically initialize a new NextJS project with the default configuration, providing a streamlined way to build applications efficiently and quickly.System Requirements:Node.js 12.22.0 or laterNPM 6.14.4 or later OR Yarn 1.22.10 or latermacOS, Wi
3 min read
Deploying your Next.js AppDeploying a Next.js app involves taking your application from your local development environment to a production-ready state where it can be accessed by users over the internet. Next.js is a popular React framework that enables server-side rendering, static site generation, and client-side rendering
3 min read
Next js Routing
Next.js RoutingNext.js is a powerful framework built on top of React that simplifies server-side rendering, static site generation, and routing. In this article, we'll learn about the fundamentals of Next.js routing, explore dynamic and nested routes, and see how to handle custom routes and API routes.Table of Con
6 min read
Next.js Nested RoutesNext.js is a popular React framework that enables server-side rendering and static site generation. One of the key features that enhance the development experience in Next.js is its routing system.While Next.js provides a file-based routing mechanism, implementing nested routes requires some additio
4 min read
Next.js PagesThe Next.js Pages are the components used to define routes in the next application. Next.js uses a file-based routing system that automatically maps files in the pages directory to application routes, supporting static, dynamic, and nested routes for seamless web development. In this article, we wil
3 min read
Next JS Layout ComponentNext JS Layout components are commonly used to structure the overall layout of a website or web application. They provide a convenient way to maintain consistent header, footer, and navigation elements across multiple pages. Let's see how you can create and use a Layout component in Next.js. Prerequ
3 min read
Navigate Between Pages in NextJSNavigating between pages in Next.js is smooth and optimized for performance, with the help of its built-in routing capabilities. The framework utilizes client-side navigation and dynamic routing to ensure fast, smooth transitions and an enhanced user experience.Prerequisites:Node.js and NPMReactJSNe
3 min read
loading.js in Next JSNext JS is a React framework that provides a number of features to help you build fast and scalable web applications. One of these features is loading.js which allows you to create a loading UI for your application.Prerequisites:JavaScript/TypeScriptReactJS BasicsNextJSLoading UI is important becaus
3 min read
Linking between pages in Next.jsIn this article, we are going to see how we can link one page to another in Next.js. Follow the below steps to set up the linking between pages in the Next.js application:To create a new NextJs App run the below command in your terminal:npx create-next-app GFGAfter creating your project folder (i.e.
2 min read
Next.js RedirectsNext.js Redirects means changing the incoming source request to the destination request and redirecting the user to that path only. When the original web application is under maintenance, the users browse or access the web application, and we want to redirect the user to another web page or applicat
4 min read
Next.js Dynamic Route SegmentsDynamic routing is a core feature in modern web frameworks, enabling applications to handle variable paths based on user input or dynamic content. In Next.js 13+, with the introduction of the App Router, dynamic routes are implemented using a folder-based structure inside the app directory.This arti
2 min read
Middlewares in Next.jsMiddlewares in Next.js provide a powerful mechanism to execute custom code before a request is completed. They enable you to perform tasks such as authentication, logging, and request manipulation, enhancing the functionality and security of your application.Table of ContentMiddleware in Next.jsConv
7 min read
Next JS Routing: InternationalizationNext.js allows you to configure routing and rendering for multiple languages, supporting both translated content and internationalized routes. This setup ensures your site adapts to different locales, providing a seamless and localized experience for users across various languages.Prerequisites:NPM
4 min read
Next js Data Fetching
Next js Rendering
How to Reset Next.js Development Cache? Next.js, a widely used React framework, offers server-side rendering, static site generation, and robust development features. However, cached data in your development environment can sometimes cause issues. Resetting the cache ensures you work with the latest data and code. Let’s explore several me
3 min read
Next js Styling
How to Add Stylesheet in Next.js ?In Next.js, adding a stylesheet enhances your app's styling capabilities. Import CSS files directly in your components or pages using ES6 import syntax. Next.js optimizes and includes these styles in the build process, ensuring efficient and modular CSS management.In this post, we are going to learn
4 min read
Controlling the specificity of CSS Modules in a Next.js AppCSS Modules are one of the popular techniques that are used for local scoping CSS in JavaScript behavioral applications. In Next.js applications, CSS Modules are mostly used to generate the unique class names for our styles, preventing them from conflicting with the styles from different components
4 min read
Install & Setup Tailwind CSS with Next.jsTailwind is a popular utility first CSS framework for rapidly building custom User Interfaces. It provides low-level classes, those classes combine to create styles for various components. You can learn more about Tailwind CSS here. Next.js: Next.js is a React-based full-stack framework developed b
2 min read
CSS-in-JS Next JSCSS-in-JS in Next.js enables you to write CSS styles directly within your JavaScript or TypeScript files. This approach allows you to scope styles to components and leverage JavaScript features, improving maintainability and modularity.In this article learn how to use CSS-in-JS in NextJS its syntax,
3 min read
Next.js Styling: SassNext.js supports various styling options, including Sass, which allows for more advanced styling techniques like variables, nested rules, and mixins. Integrating Sass into a Next.js project enhances your styling capabilities and makes managing styles more efficient and maintainable.In this article,
3 min read
Next js Optimizing
Next.js Bundle Optimization to improve PerformanceIn this article, We will learn various ways to improve the performance of the NextJS bundle which results in increasing the performance of NextJS applications in Google PageSpeed Insights or Lighthouse. As per the documentation, NextJS is a React framework that gives you the building blocks to creat
6 min read
Next JS Image Optimization: Best Practices for Faster LoadingLarge and unoptimized images can impact a website's performance on loading time. Optimizing images is necessary to improve the performance of the website. Next.js provides built-in support for image optimization to automate the process, providing a balance between image quality and loading speed. Pr
4 min read
Next.js Functions : generateMetadataNextJS is a React framework that is used to build full-stack web applications. It is used both for front-end as well and back-end. It simplifies React development with powerful features. One of its features is generateMetadata. In this article, we will learn about the generateMetadata function with
3 min read
Lazy Loading in Next.jsLazy loading in NextJS is a technique used to improve the performance and loading times of web applications built with the NextJS framework. With lazy loading, components or modules are loaded only when they are needed, rather than upfront when the page is initially rendered. This means that resourc
4 min read
How to Add Google Analytics to a Next.js Application?Adding Google Analytics to a Next.js application allows you to track and analyze your website's traffic and user actions. This can provide valuable insights into how users interact with your site, helping you make informed decisions to improve user experience and drive business goals. This article h
3 min read
Next.js Static File ServingNext.js allows you to serve static files from the public directory, making them accessible at the root URL. This feature enables easy inclusion of assets like images, fonts, and static HTML files, enhancing your application's functionality and user experience.Static filesAll those files which need t
2 min read
Next js Configuring
Next.js TypeScriptNextJS is a powerful and popular JavaScript framework that is used for building server-rendered React applications. . It provides a development environment with built-in support for TypeScript, as well as a set of features that make it easy to build and deploy web applications. It was developed by Z
4 min read
Next.js ESLintESLint is a widely-used tool for identifying and fixing problems in JavaScript code. In Next.js projects, integrating ESLint helps ensure code quality and consistency by enforcing coding standards and catching errors early in the development process.In this article, we'll explore how to set up ESLin
3 min read
Next.js Environment VariablesEnvironment variables are a fundamental aspect of modern web development, allowing developers to configure applications based on the environment they are running in (development, testing, production, etc.). In Next.js, environment variables provide a flexible and secure way to manage configuration s
3 min read
MDX in Next JSMDXÂ is a lightweight markup language used to format text. It allows you to write using plain text syntax and convert it to structurally valid HTML. It's commonly used for writing content on websites and blogs. In this article we will see more about MDX in Next JSWhat is MDX?MDX stands for Multidimen
4 min read
Next.js src DirectoryThe NextJS src directory is a project structure that is optional but is widely recommended. It helps to organize the project in a well-defined structure.Organizing a Next.js project with a well-planned folder structure is important for readability, scalability, and maintainability. A clear structure
4 min read
Draft Mode Next.jsDraft Mode in Next.js enables content previewing and editing directly within your application, allowing content creators to view changes before publishing. This feature is especially useful for content management systems or any app where content updates need to be reviewed in real-time. We will expl
5 min read
Next.js Security HeadersNext.js security headers help protect your application from common web vulnerabilities by enforcing security policies at the HTTP level. By configuring these headers, you enhance your app's security and ensure safer interactions for your users.In this article, we’ll learn about security headers, the
6 min read
Unit Testing in Next JS: Ensuring Code Quality in Your Project Unit testing in Next.js ensures that individual components and functions work as expected. It improves code reliability, helps catch bugs early, and facilitates easier maintenance and refactoring by verifying the correctness of isolated units of code. Unit testing is an essential aspect of software
4 min read