-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
93 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
--- | ||
title: "Kitchen sink" | ||
description: "A test page for custom components" | ||
slug: "en/kitchen-sink/index" | ||
category-title: "Kitchen sink" | ||
--- | ||
|
||
This page includes documentation for this site's custom authoring components and examples of their use. | ||
|
||
## Callouts | ||
|
||
Callouts are `<aside>` components which display additional information in visually distinct ways. | ||
|
||
### Props | ||
|
||
| Prop | Data type | Values | Required | | ||
| ------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | | ||
| `type` | String | <ul><li><code>note</code></li><li><code>tip</code></li><li><code>caution</code></li><li><code>danger</code></li><li><code>seealso</code></li></ul> | No. Defaults to `note` | | ||
| `title` | String | The title of the callout | No. Defaults to `type` | | ||
|
||
### Examples | ||
|
||
#### Note callout | ||
|
||
```mdx | ||
<Aside type="note" title="A note callout"> | ||
This is a *note* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
``` | ||
|
||
<Aside type="note" title="A note callout"> | ||
This is a *note* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
|
||
#### Tip callout | ||
|
||
```mdx | ||
<Aside type="tip" title="A tip callout"> | ||
This is a *tip* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
``` | ||
|
||
<Aside type="tip" title="A tip callout"> | ||
This is a *tip* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
|
||
#### Caution callout | ||
|
||
```mdx | ||
<Aside type="caution" title="A caution callout"> | ||
This is a *caution* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
``` | ||
|
||
<Aside type="caution" title="A caution callout"> | ||
This is a *caution* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
|
||
#### Danger callout | ||
|
||
```mdx | ||
<Aside type="danger" title="A danger callout"> | ||
This is a *danger* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
``` | ||
|
||
<Aside type="danger" title="A danger callout"> | ||
This is a *danger* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
|
||
#### Seealso callout | ||
|
||
```mdx | ||
<Aside type="seealso" title="A seealso callout"> | ||
This is a *seealso* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> | ||
``` | ||
|
||
<Aside type="seealso" title="A seealso callout"> | ||
This is a *seealso* callout. It **renders** | ||
[Markdown](https://www.markdownguide.org/). | ||
</Aside> |