docs: create SEO documentation page (#5759)

Co-authored-by: Josh-Cena <[email protected]>
facebook · Nov 4, 2021 · 4922764 · 4922764
1 parent 8ccc41c
commit 4922764
Show file tree

Hide file tree

Showing 2 changed files with 122 additions and 0 deletions.
diff --git a/website/docs/seo.md b/website/docs/seo.md
@@ -0,0 +1,121 @@
+---
+id: seo
+title: Search engine optimization (SEO)
+sidebar_label: SEO
+keywords:
+  - seo
+  - positioning
+---
+
+Docusaurus supports search engine optimization in a variety of ways.
+
+## 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
+  },
+};
+```
+
+Docusaurus adds some metadata out-of-the-box. For example, if you have configured [i18n](./i18n/i18n-introduction.md), you will get a [`hreflang`](https://developers.google.com/search/docs/advanced/crawling/localized-versions) alternate link.
+
+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}
+
+Similar to [global metadata](#global-metadata), Docusaurus also allows for the addition of meta-information to individual pages. Follow [this guide](./guides/markdown-features/markdown-features-head-metadatas.mdx) for configuring the `<head>` tag. In short:
+
+```md title="my-markdown-page.md"
+# A cooking guide
+
+<head>
+  <meta name="keywords" content="cooking, blog">
+</head>
+
+Some content...
+```
+
+```jsx title="my-react-page.jsx"
+import React from 'react';
+import Head from '@docusaurus/Head';
+
+export default function page() {
+  return (
+    <Layout title="Page" description="A React page demo">
+      <Head>
+        <meta property="og:image" content="image.png" />
+      </Head>
+      {/* ... */}
+    </Layout>
+  );
+}
+```
+
+Docusaurus automatically adds `description`, `title`, canonical URL links, and other useful metadata to each Markdown page. They are configurable through front matter:
+
+```yml
+---
+title: Title for search engines; can be different from the actual heading
+description: A short description of this page
+image: a thumbnail image to be shown in social media cards
+keywords: [keywords, describing, the main topics]
+---
+```
+
+When creating your React page, adding these fields in `Layout` would also improve SEO.
+
+## 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 more easily.
+
+## Image meta description {#image-meta-description}
+
+The alt tag for an image tells the search engine what the image is about, and is used when the image can't be visually seen, e.g. when using a screen reader, or when the image is broken. Alt tags are commonly supported in Markdown.
+
+You may also add a title for your image—this doesn't impact SEO much, but is displayed as tooltip when hovering above the image, usually used to provide hints.
+
+```md
+![Docusaurus banner](./assets/docusaurus-asset-example-banner.png 'Image title')
+```
+
+![Docusaurus banner](./assets/docusaurus-asset-example-banner.png 'Image title')
+
+## Rich search information {#rich-search-information}
+
+Docusaurus blogs support [rich search results](https://search.google.com/test/rich-results) out-of-the-box 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 that 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="static/robots.txt"
+User-agent: *
+Disallow:
+```
+
+Read more about the 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 with `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}
+
+Search engines rely on the HTML markup such as `<h2>`, `<table>`, etc., to understand the structure of your webpage. When Docusaurus renders your pages, semantic markup, e.g. `<aside>`, `<nav>`, `<main>`, are used to divide the different sections of the page, helping the search engine to locate parts like sidebar, navbar, and the main page content.
+
+Most [CommonMark](https://spec.commonmark.org/0.30/#atx-headings) syntax have their corresponding HTML tags. By using Markdown consistently in your project, you will make it easier for search engines to understand your page content.
diff --git a/website/sidebars.js b/website/sidebars.js
@@ -59,6 +59,7 @@ const sidebars = {
         'static-assets',
         'search',
         'browser-support',
+        'seo',
         'deployment',
         {
           type: 'category',