From 0d6108faae0e9811f9082b8ec4b5f84cc1796d86 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 12 Feb 2025 07:34:28 -0500 Subject: [PATCH] Fix Alerts example, and copyedit intro of using-markdown-and-liquid-in-github-docs.md (#36266) --- .../using-markdown-and-liquid-in-github-docs.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md index caa058d043de..135c4679f61d 100644 --- a/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md +++ b/content/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md @@ -50,14 +50,13 @@ This content is displayed on the {% data variables.product.prodname_docs %} site ## Alerts -Alerts highlight important information that users need to know. We use standard formatting and colors for four different types of Alerts: Note, Tip, Warning, and Caution. - -For information on when to use alerts, and how to format them in Markdown, see [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#alerts). +Alerts highlight important information that users need to know. For details about supported alert types, how to format them in Markdown, and information on when to use alerts, see [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#alerts). ### Examples of alerts ```markdown -> [!NOTE] Keep this in mind. +> [!TIP] +> Try this out! ``` ```markdown @@ -69,6 +68,9 @@ For information on when to use alerts, and how to format them in Markdown, see [ ### Example alerts rendered on {% data variables.product.prodname_docs %} +> [!TIP] +> Try this out! + > [!NOTE] > Generally alerts should be short. >