Skip to content
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

Fix Alerts example, and copyedit intro of using-markdown-and-liquid-in-github-docs.md #36266

Merged
merged 1 commit into from
Feb 12, 2025
Merged

Fix Alerts example, and copyedit intro of using-markdown-and-liquid-in-github-docs.md #36266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions ...ontributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs.md
View file
Open in desktop
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
Loading