22
33## Alert Examples
44
5+ The examples below should work in GitHub, Visual Studio Code, and Obsidian.
6+
57### Note
68
79> [ !NOTE]
4244
4345### Callout With Custom Title
4446
45- Obsidian supports rendering callouts with a custom title. GitHub, however, does not.
47+ Obsidian and Visual Studio Code supports rendering callouts with a custom title.
48+ GitHub, at the time of writing, does not.
49+
50+ > [!IMPORTANT] Pay Attention!
51+ > Crucial information necessary for users to succeed.
52+
53+ #### Syntax
4654
55+ ` ` ` markdown
4756> [! IMPORTANT ] Pay Attention!
4857> Crucial information necessary for users to succeed.
58+ ```
59+
60+ #### Screenshot
61+
62+ ![ example of an alert with a custom title as rendered in Obsidian] ( ./assets/custom-title-alert.png )
4963
5064### Nested Alerts
5165
52- Obsidian supports rendering nested callouts. GitHub, at the time of writing, does not:
66+ Obsidian supports rendering nested callouts. GitHub and Visual Studio Code , at the time of writing, do not:
5367
5468> [ !NOTE]
5569> Highlights information that users should take into account, even when skimming.
@@ -62,6 +76,25 @@ Obsidian supports rendering nested callouts. GitHub, at the time of writing, doe
6276 > > > > > [ !CAUTION]
6377 > > > > > Negative potential consequences of an action.
6478
79+ #### Syntax
80+
81+ ``` markdown
82+ > [ !NOTE]
83+ > Highlights information that users should take into account, even when skimming.
84+ > > [ !TIP]
85+ > > Optional information to help a user be more successful.
86+ > > > [ !IMPORTANT]
87+ > > > Crucial information necessary for users to succeed.
88+ > > > > [ !WARNING]
89+ > > > > Critical content demanding immediate user attention due to potential risks.
90+ > > > > > [ !CAUTION]
91+ > > > > > Negative potential consequences of an action.
92+ ```
93+
94+ #### Screenshot
95+
96+ ![ example of nested alerts rendered in Obsidian] ( ./assets/nested-alerts.png )
97+
6598## Resources
6699
67100- < https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts >
0 commit comments