Skip to content
Merged
Changes from all commits
Commits
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
34 changes: 27 additions & 7 deletions src/content/docs/style-guide/components/asides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Asides are a built-in component provided by [Starlight](https://starlight.astro.

## Note

Use Note for small additions or when you need to provide extra context that is not essential to the main content.

If you do not provide a header, this aside will default to `Note`.

```mdx
:::note[Header]
Hello, world!
Expand All @@ -16,18 +20,34 @@ Hello, world!
Hello, world!
:::

The default header text is `Note`.

## Caution

Use Caution to highlight actions that could cause issues for a user.

If you do not provide a header, this aside will default to `Warning`.

```mdx
:::caution[Header]
Hello, world!
:::caution[Feature conflict]
If you use feature A and feature B together, your configuration will not work.
:::
```

:::caution[Header]
Hello, world!
:::caution[Feature conflict]
If you use feature A and feature B together, your configuration will not work.
:::

The default header text is `Warning`.
## Tip

Use Tip to share best practices or opinionated use cases that do not fit into the main documentation.

If you do not provide a header, this aside will default to `Tip`.

```mdx
:::tip[Best practice]
Cloudflare recommends you use [1.1.1.1](/1.1.1.1/) as your DNS resolver.
:::
```

:::tip[Best practice]
Cloudflare recommends you use [1.1.1.1](/1.1.1.1/) as your DNS resolver.
:::