Skip to content

Commit

Permalink
changed README admonitions to their GitHub feature texts
Browse files Browse the repository at this point in the history
  • Loading branch information
Helveg committed Sep 28, 2024
1 parent 42351e5 commit b1814d8
Showing 1 changed file with 26 additions and 23 deletions.
49 changes: 26 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,47 +8,50 @@ blocks for notes, warnings, tips, cautions, and important messages.

The following admonitions are supported:

- **Important**: `> [!IMPORTANT]`
- **Note**: `> [!NOTE]`
- **Tip**: `> [!TIP]`
- **Warning**: `> [!WARNING]`
- **Caution**: `> [!CAUTION]`
| **Type** | **Markdown** |
|---------------|-----------------------|
| Note | `> [!NOTE]` |
| Tip | `> [!TIP]` |
| Important | `> [!IMPORTANT]` |
| Warning | `> [!WARNING]` |
| Caution | `> [!CAUTION]` |


### Example Usage

To use admonitions in your markdown files, simply add the following syntax:

```markdown
> [!IMPORTANT]
> This is an **important** message.

> [!NOTE]
> This is a **note**.
> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> This is a **helpful** tip.
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> This is a **warning**.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> This is a **caution** message.
> Negative potential consequences of an action.
```

> [!IMPORTANT]
> This is an **important** message.
> [!NOTE]
> This is a **note**.
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!TIP]
> This is a **helpful** tip.
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> This is a **warning**.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> This is a **caution** message.
> Negative potential consequences of an action.
## Installation

Expand Down

0 comments on commit b1814d8

Please sign in to comment.