Skip to content

Commit 9c04260

Browse files
authored
Add Tips to Asides (#25601)
1 parent ac3c367 commit 9c04260

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

src/content/docs/style-guide/components/asides.mdx

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Asides are a built-in component provided by [Starlight](https://starlight.astro.
66

77
## Note
88

9+
Use Note for small additions or when you need to provide extra context that is not essential to the main content.
10+
11+
If you do not provide a header, this aside will default to `Note`.
12+
913
```mdx
1014
:::note[Header]
1115
Hello, world!
@@ -16,18 +20,34 @@ Hello, world!
1620
Hello, world!
1721
:::
1822

19-
The default header text is `Note`.
20-
2123
## Caution
2224

25+
Use Caution to highlight actions that could cause issues for a user.
26+
27+
If you do not provide a header, this aside will default to `Warning`.
28+
2329
```mdx
24-
:::caution[Header]
25-
Hello, world!
30+
:::caution[Feature conflict]
31+
If you use feature A and feature B together, your configuration will not work.
2632
:::
2733
```
2834

29-
:::caution[Header]
30-
Hello, world!
35+
:::caution[Feature conflict]
36+
If you use feature A and feature B together, your configuration will not work.
3137
:::
3238

33-
The default header text is `Warning`.
39+
## Tip
40+
41+
Use Tip to share best practices or opinionated use cases that do not fit into the main documentation.
42+
43+
If you do not provide a header, this aside will default to `Tip`.
44+
45+
```mdx
46+
:::tip[Best practice]
47+
Cloudflare recommends you use [1.1.1.1](/1.1.1.1/) as your DNS resolver.
48+
:::
49+
```
50+
51+
:::tip[Best practice]
52+
Cloudflare recommends you use [1.1.1.1](/1.1.1.1/) as your DNS resolver.
53+
:::

0 commit comments

Comments
 (0)