From f84eb073e754d5db7008a4f496302707cbfbde75 Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Fri, 17 Dec 2021 19:29:51 +0800 Subject: [PATCH] docs: mention that SEO through front matter is better than head tag (#6112) --- .../markdown-features/markdown-features-head-metadata.mdx | 6 ++++++ website/docs/seo.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/website/docs/guides/markdown-features/markdown-features-head-metadata.mdx b/website/docs/guides/markdown-features/markdown-features-head-metadata.mdx index c48caf9fcc..ee0c03a53b 100644 --- a/website/docs/guides/markdown-features/markdown-features-head-metadata.mdx +++ b/website/docs/guides/markdown-features/markdown-features-head-metadata.mdx @@ -52,6 +52,12 @@ Open your browser DevTools and check how this page's metadata have been affected ::: +:::tip + +**You don't always need this for typical SEO needs.** Content plugins (e.g. docs and blog) provide front matter options like `description`, `keywords`, and `image`, which will be automatically applied to both `description` and `og:description`, while you would have to manually declare two metadata tags when using the `` tag. + +::: + :::note This feature is built on top of the Docusaurus [``](./../../docusaurus-core.md#head) component. diff --git a/website/docs/seo.md b/website/docs/seo.md index 6fe946bb91..314970f092 100644 --- a/website/docs/seo.md +++ b/website/docs/seo.md @@ -69,6 +69,12 @@ keywords: [keywords, describing, the main topics] When creating your React page, adding these fields in `Layout` would also improve SEO. +:::tip + +Prefer to use front matter for fields like `description` and `keywords`: Docusaurus will automatically apply this to both `description` and `og:description`, while you would have to manually declare two metadata tags when using the `` tag. + +::: + ## 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.