Skip to content

Commit

Permalink
Fix Alerts example, and copyedit intro of using-markdown-and-liquid-i…
Browse files Browse the repository at this point in the history
…n-github-docs.md (#36266)
  • Loading branch information
chalin authored Feb 12, 2025
1 parent ae41043 commit 0d6108f
Showing 1 changed file with 6 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
>
Expand Down

0 comments on commit 0d6108f

Please sign in to comment.