Skip to content

Add "blockquote" to alerts description to improve SEO #28140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
felicitymay merged 4 commits into from
Sep 12, 2023
Merged

Add "blockquote" to alerts description to improve SEO #28140

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9a6bb9
Add "blockquote" to improve SEO
felicitymay Sep 11, 2023
ab5e1a5
Update for self-review
felicitymay Sep 11, 2023
b6fa443
Update content/get-started/writing-on-github/getting-started-with-wri…
felicitymay Sep 11, 2023
c86667d
Merge branch 'main' into felicitymay-add-blockquote
felicitymay Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...ed-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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 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.
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]
Expand Down