docs: create SEO documentation page #5759

---
id: seo
title: Search engine optimization (SEO)
sidebar_label: SEO
keywords:
  - seo
  - positioning
---

Docusaurus supports the search engine optimization in a variety of ways.

```mdx-code-block
import TOCInline from '@theme/TOCInline';

<TOCInline toc={toc} />
```

## Global metadata {#global-metadata}

Provide global meta attributes for the entire site through the [site configuration](./configuration.md#site-metadata). The metadatas will all be rendered in the HTML `<head>` using the key-value pairs as the prop name and value.

```js title="docusaurus.config.js"
module.exports = {
  themeConfig: {
    metadatas: [{name: 'keywords', content: 'cooking, blog'}],
    // This would become <meta name="keywords" content="cooking, blog"> in the generated HTML
  },
};
```

To read more about types of meta tags, visit [the MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta).

## Single page metadata {#single-page-metadata}

Similarly to [global metadata](#global-metadata), Docusaurus also allows for addition of meta information on single pages. In order to add metadata to single page follow [this guide](./guides/markdown-features/markdown-features-head-metadatas.mdx) for head tag extension.

## Static HTML generation {#static-html-generation}

Docusaurus is a static site generator—HTML files are statically generated for every URL route, which helps search engines discover your content easier.

## Image meta description {#image-meta-description}

Docusaurus supports alt tags for your images, see [this section](./guides/markdown-features/markdown-features-assets.mdx#images) for more details.

## Rich search information {#rich-search-information}

Docusaurus blogs support [rich search results](https://search.google.com/test/rich-results) out-of-the-box in order to get maximum search engine experience. The information is created depending on your meta information in blog/global configuration. In order to get the benefits of the rich search information, fill in the information about the post's publish date, authors, and image, etc. Read more about the meta information [here](./blog.mdx).

## Robots file {#robots-file}

To add a `robots.txt` file which regulates search engines' behavior about which should be displayed and which shouldn't, provide it as [static asset](./static-assets.md). The following would allow access to all sub-pages from all requests:

```text title="robots.txt"
User-agent: *
Disallow:
```

Read more about robots file in [the Google documentation](https://developers.google.com/search/docs/advanced/robots/intro).

:::caution

**Important**: the `robots.txt` file does **not** prevent HTML pages from being indexed. Use `<meta name="robots" content="noindex">` as [page metadata](#single-page-metadata) to prevent it from appearing in search results entirely.

:::

## Sitemap file {#sitemap-file}

Docusaurus provides the [`@docusaurus/plugin-sitemap`](./api/plugins/plugin-sitemap.md) plugin, which is shipped wih `preset-classic` by default. It autogenerates a `sitemap.xml` file which will be available at `https://example.com/<baseUrl>/sitemap.xml` after the production build. This sitemap metadata helps search engine crawlers crawl your site more accurately.

## Human readable links {#human-readable-links}

Docusaurus uses your file names as links, but you can always change that using slugs, see this [tutorial](./guides/docs/docs-introduction.md#document-id) for more details.

## Structured content {#structured-content}

Docusaurus provides you with option to structure your content in terms of how your data are presented in search engine see this [configuration option](./guides/markdown-features/markdown-features-head-metadatas.mdx). The structure of the site itself is rigid through specification of [common markdown](https://spec.commonmark.org/0.30/#atx-headings), this makes it easier for the search engines to classify and read your content. By using Markdown consistently in your project you will make it easy for search engines to understand your content.

You may re-open a PR.

cerkiewny · 2021-11-01T10:15:44Z

Sorry for that, I wanted to clean my repo history to be identical with upstream, forgot I am mergint this one from main and not dedicated branch

slorber

Thanks, LGTM overall

There are a few typos and weird sentences, can you double-check your content in a tool like Grammarly?

Also worth mentioning that the i18n feature adds hreflang headers:

Good SEO defaults: we set useful SEO headers like hreflang for you

website/docs/seo.md

slorber · 2021-11-03T19:20:26Z

website/docs/seo.md

+
+## Structured content {#structured-content}
+
+Docusaurus provides you with option to structure your content in terms of how your data are presented in search engine see this [configuration option](./guides/markdown-features/markdown-features-head-metadatas.mdx). The structure of the site itself is rigid through specification of [common markdown](https://spec.commonmark.org/0.30/#atx-headings), this makes it easier for the search engines to classify and read your content. By using Markdown consistently in your project you will make it easy for search engines to understand your content.


not sure to understand what you mean here?

You could have someone design <div>-based website (like back in a day), it is really hard if you are using Markdown as it provides good defaults. And this in turn helps search engines to spot things like h1 which allows them to easier understand the content.

Oh I see thanks

I thought you wanted to talk about structured data, that we also use a bit on blog posts:
https://developers.google.com/search/docs/advanced/structured-data/article

slorber · 2021-11-04T11:57:21Z

LGTM thanks 👍

cerkiewny requested review from lex111 and slorber as code owners October 21, 2021 14:38

facebook-github-bot added the CLA Signed label Oct 21, 2021

Josh-Cena reviewed Oct 21, 2021

View reviewed changes

website/sidebars.js Outdated Show resolved Hide resolved

Josh-Cena reviewed Oct 21, 2021

View reviewed changes

website/docs/guides/seo.md Outdated Show resolved Hide resolved

Josh-Cena reviewed Oct 22, 2021

View reviewed changes

website/docs/guides/seo.md Outdated Show resolved Hide resolved

Josh-Cena reviewed Oct 22, 2021

View reviewed changes

website/docs/guides/seo.md Outdated Show resolved Hide resolved

Josh-Cena reviewed Oct 22, 2021

View reviewed changes

website/docs/guides/seo.md Outdated Show resolved Hide resolved

cerkiewny force-pushed the main branch from df44edc to df60672 Compare October 22, 2021 17:15

juzhiyuan reviewed Oct 26, 2021

View reviewed changes

website/docs/seo.md Outdated Show resolved Hide resolved

Josh-Cena added the pr: documentation label Oct 28, 2021

cerkiewny closed this Nov 1, 2021

cerkiewny force-pushed the main branch from e47d848 to 895c848 Compare November 1, 2021 09:50

cerkiewny and others added 5 commits November 1, 2021 11:12

docs: create SEO documentation page

b23fdc7

fixup! docs: create SEO documentation page

fc32fa1

fixup! docs: create SEO documentation page

ab06842

fixup! fixup! docs: create SEO documentation page

7f88d91

Polish wording

d2d4fed

cerkiewny reopened this Nov 1, 2021

slorber requested changes Nov 3, 2021

View reviewed changes

Josh-Cena added 3 commits November 4, 2021 07:31

Fixes

0deba67

Grammar fixes

0e9d337

More about metadata

a8ee9d8

Josh-Cena requested a review from slorber November 4, 2021 10:30

slorber merged commit 4922764 into facebook:main Nov 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: create SEO documentation page #5759

docs: create SEO documentation page #5759

cerkiewny commented Oct 21, 2021 •

edited by Josh-Cena

Loading

netlify bot commented Oct 22, 2021 •

edited

Loading

github-actions bot commented Oct 22, 2021 •

edited

Loading

Josh-Cena commented Nov 1, 2021 •

edited

Loading

cerkiewny commented Nov 1, 2021

slorber left a comment

slorber Nov 3, 2021

cerkiewny Nov 3, 2021 •

edited

Loading

slorber Nov 4, 2021

slorber commented Nov 4, 2021


		## Structured content {#structured-content}

		Docusaurus provides you with option to structure your content in terms of how your data are presented in search engine see this [configuration option](./guides/markdown-features/markdown-features-head-metadatas.mdx). The structure of the site itself is rigid through specification of [common markdown](https://spec.commonmark.org/0.30/#atx-headings), this makes it easier for the search engines to classify and read your content. By using Markdown consistently in your project you will make it easy for search engines to understand your content.

docs: create SEO documentation page #5759

docs: create SEO documentation page #5759

Conversation

cerkiewny commented Oct 21, 2021 • edited by Josh-Cena Loading

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

netlify bot commented Oct 22, 2021 • edited Loading

github-actions bot commented Oct 22, 2021 • edited Loading

Josh-Cena commented Nov 1, 2021 • edited Loading

cerkiewny commented Nov 1, 2021

slorber left a comment

Choose a reason for hiding this comment

slorber Nov 3, 2021

Choose a reason for hiding this comment

cerkiewny Nov 3, 2021 • edited Loading

Choose a reason for hiding this comment

slorber Nov 4, 2021

Choose a reason for hiding this comment

slorber commented Nov 4, 2021

cerkiewny commented Oct 21, 2021 •

edited by Josh-Cena

Loading

netlify bot commented Oct 22, 2021 •

edited

Loading

github-actions bot commented Oct 22, 2021 •

edited

Loading

Josh-Cena commented Nov 1, 2021 •

edited

Loading

cerkiewny Nov 3, 2021 •

edited

Loading