From 5bd6284f18a0ae2aee6bb30da00cff2fdb8cec39 Mon Sep 17 00:00:00 2001 From: bravo-kernel Date: Sun, 20 Oct 2019 19:49:28 +0200 Subject: [PATCH] docs(v2): clarify that front matter 'description' is used as a meta tag (#1862) --- website/docs/markdown-features.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/website/docs/markdown-features.mdx b/website/docs/markdown-features.mdx index 3697b82b22..ff2a8faa86 100644 --- a/website/docs/markdown-features.mdx +++ b/website/docs/markdown-features.mdx @@ -101,9 +101,9 @@ Documents use the following markdown header fields that are enclosed by a line ` - `hide_title`: Whether to hide the title at the top of the doc. By default it is `false`. - `sidebar_label`: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's `sidebar_label` will default to its `title`. - `custom_edit_url`: The URL for editing this document. If this field is not present, the document's edit URL will fall back to `editUrl` from options fields passed to `docusaurus-plugin-content-docs`. -- `description`: Description of this document page. +- `description`: Description meta tag for the document page, for search engines. If this field is not present, it will default to the first line of the contents. +- `keywords`: Keywords meta tag for the document page, for search engines. - `image`: Cover or thumbnail image that will be used when displaying the link to your post. -- `keywords`: Keywords for search engines. Example: @@ -111,12 +111,13 @@ Example: --- id: doc-markdown title: Markdown Features +hide_title: false sidebar_label: Markdown :) custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md +description: How do I find you when I cannot solve this problem keywords: - docs - docusaurus -description: How do I find you when I cannot solve this problem image: https://i.imgur.com/mErPwqL.png ---