Skip to content

Commit 893e57a

Browse files
felicitymaysubatoi
andauthored
Add "blockquote" to alerts description to improve SEO (#28140)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent 02cae0e commit 893e57a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -345,15 +345,15 @@ Footnotes are not supported in wikis.
345345

346346
{% note %}
347347

348-
**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.
348+
**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.
349349

350350
{% endnote %}
351351

352-
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.
352+
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.
353353

354354
We recommend restricting the use of alerts to one or two per article to avoid overloading the reader. Consecutive notes should be avoided.
355355

356-
There are three types of alerts available.
356+
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.
357357

358358
```
359359
> [!NOTE]

0 commit comments

Comments
 (0)