From d9a6bb99be73bfbc9182879c559099e33c0dd7e0 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Mon, 11 Sep 2023 11:02:34 +0100 Subject: [PATCH 1/3] Add "blockquote" to improve SEO As suggested by jsoref --- .../basic-writing-and-formatting-syntax.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index 3472ad3b6030..f59ae81373c4 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -349,11 +349,11 @@ Footnotes are not supported in wikis. {% endnote %} -Alerts are an extension of Markdown used to emphasize critical information. On {% data variables.product.product_name %}, they are displayed with distinctive colors and icons to indicate the importance of the content. +Alerts are an extension of the Markdown blockquote syntax that you can use to emphasize critical information. On {% data variables.product.product_name %}, they are displayed with distinctive colors and icons to indicate the importance of the content. We recommend restricting the use of alerts to one or two per article to avoid overloading the reader. Consecutive notes should be avoided. -There are three types of alerts available. +You define alerts by adding a prefix line to blockquote syntax. Three types of alert are available. ``` > [!NOTE] From ab5e1a5139817960766892dd50ae91ec1a5825aa Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Mon, 11 Sep 2023 11:11:33 +0100 Subject: [PATCH 2/3] Update for self-review --- .../basic-writing-and-formatting-syntax.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index f59ae81373c4..4e1c8851fce1 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -345,15 +345,15 @@ Footnotes are not supported in wikis. {% note %} -**Note**: The syntax used during the beta testing period is now deprecated and will be removed. You can use the syntax as described in this section. +**Note**: The Markdown syntax used during the beta testing period is now deprecated and will be removed. You can use the syntax as described in this section. {% endnote %} -Alerts are an extension of the Markdown blockquote syntax that you can use to emphasize critical information. On {% data variables.product.product_name %}, they are displayed with distinctive colors and icons to indicate the importance of the content. +Alerts are an extension of the blockquote syntax that you can use to emphasize critical information. On {% data variables.product.product_name %}, they are displayed with distinctive colors and icons to indicate the importance of the content. We recommend restricting the use of alerts to one or two per article to avoid overloading the reader. Consecutive notes should be avoided. -You define alerts by adding a prefix line to blockquote syntax. Three types of alert are available. +Three types of alert are available. You add an alert using a special blockquote line that specifies the alert type, then specifying the alert information in a standard blockquote. ``` > [!NOTE] From b6fa44331dcf16f45f4bc1d1e97074e17eae8910 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Mon, 11 Sep 2023 12:59:55 +0100 Subject: [PATCH 3/3] Update content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> --- .../basic-writing-and-formatting-syntax.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index 4e1c8851fce1..549f0f0712a9 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -353,7 +353,7 @@ Alerts are an extension of the blockquote syntax that you can use to emphasize c We recommend restricting the use of alerts to one or two per article to avoid overloading the reader. Consecutive notes should be avoided. -Three types of alert are available. You add an alert using a special blockquote line that specifies the alert type, then specifying the alert information in a standard blockquote. +Three types of alert are available. You can add an alert with a special blockquote line that specifies the alert type, and then add the alert information in a standard blockquote immediately after. ``` > [!NOTE]