Skip to content

Commit

Permalink
Update contributing doc to match style guide (#50139)
Browse files Browse the repository at this point in the history
  • Loading branch information
hubwriter authored Apr 15, 2024
1 parent 3b8cce8 commit d246b92
Showing 1 changed file with 15 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -50,27 +50,29 @@ This content is displayed on the {% data variables.product.prodname_docs %} site

## Callout tags

Callouts highlight important information that users need to know. We use standard formatting and colors for different types of callouts: notes, warnings, and danger notices. Use Liquid tags before and after the text you’d like included in the callout box.
Callouts highlight important information that users need to know. We use standard formatting and colors for four different types of callouts: notes, tips, warnings, and danger notices.

For information on when to use callout tags, see "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#callouts)."
For information on when to use callouts, and how to format them in Markdown, see "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#callouts)."

### Example usage of a callout
### Examples of callouts

```markdown
{% raw %}{% note %}

**Note:** Owners and administrators can add outside collaborators to a repository.

{% endnote %}{% endraw %}
> [!NOTE] Keep this in mind.
```

### Example callout rendered on {% data variables.product.prodname_docs %}

{% note %}
```markdown
> [!NOTE]
> Generally callouts should be short.
>
> But occasionally may require more than one paragraph
```

**Note:** Owners and administrators can add outside collaborators to a repository.
### Example callouts rendered on {% data variables.product.prodname_docs %}

{% endnote %}
> [!NOTE]
> Generally callouts should be short.
>
> But occasionally may require more than one paragraph
## Code sample syntax highlighting

Expand Down

0 comments on commit d246b92

Please sign in to comment.