-
-
Notifications
You must be signed in to change notification settings - Fork 570
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
โฆ2339) Co-authored-by: HiDeoo <[email protected]>
- Loading branch information
Showing
2 changed files
with
167 additions
and
9 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
--- | ||
title: ๋ณด์กฐ ๋ด์ฉ | ||
description: Starlight์์ ๋ณด์กฐ ๋ด์ฉ์ ์ฌ์ฉํ์ฌ ํ์ด์ง์ ์ฃผ์ ์ฝํ ์ธ ์ ํจ๊ป ๋ณด์กฐ ์ ๋ณด๋ฅผ ํ์ํ๋ ๋ฐฉ๋ฒ์ ์์๋ณด์ธ์. | ||
--- | ||
|
||
import { Aside } from '@astrojs/starlight/components'; | ||
|
||
ํ์ด์ง์ ์ฃผ์ ์ฝํ ์ธ ์ ํจ๊ป ๋ณด์กฐ ์ ๋ณด๋ฅผ ํ์ํ๋ ค๋ฉด `<Aside>` ์ปดํฌ๋ํธ๋ฅผ ์ฌ์ฉํฉ๋๋ค. | ||
|
||
import Preview from '~/components/component-preview.astro'; | ||
|
||
<Preview> | ||
|
||
<Aside slot="preview"> | ||
ํ์์ ์ด์ง ์์ ๋ณด์ถฉ ์ ๋ณด๋ `<Aside>`์ ํฌํจํ์ธ์. | ||
</Aside> | ||
|
||
</Preview> | ||
|
||
## ๊ฐ์ ธ์ค๊ธฐ | ||
|
||
```tsx | ||
import { Aside } from '@astrojs/starlight/components'; | ||
``` | ||
|
||
## ์ฌ์ฉ | ||
|
||
`<Aside>` ์ปดํฌ๋ํธ๋ฅผ ์ฌ์ฉํ์ฌ ๋ณด์กฐ ๋ด์ฉ (โadmonitionsโ ๋๋ โcalloutsโ์ด๋ผ๊ณ ๋ ํจ)์ ํ์ํฉ๋๋ค. | ||
|
||
`<Aside>`์๋ ๋ณด์กฐ ๋ด์ฉ์ ์์, ์์ด์ฝ ๋ฐ ๊ธฐ๋ณธ ์ ๋ชฉ์ ์ ์ดํ๋ ์ ํ์ [`type`](#type) ์์ฑ์ด ์์ ์ ์์ต๋๋ค. | ||
|
||
<Preview> | ||
|
||
````mdx | ||
import { Aside } from '@astrojs/starlight/components'; | ||
|
||
<Aside>๋ณด์กฐ ๋ด์ฉ์ ์ฝํ ์ธ ์ ๋๋ค.</Aside> | ||
|
||
<Aside type="caution">๋ช ๊ฐ์ง ์ฃผ์ํด์ผ ํ ๋ด์ฉ์ ๋๋ค.</Aside> | ||
|
||
<Aside type="tip"> | ||
|
||
๋ณด์กฐ ๋ด์ฉ์๋ ๋ค๋ฅธ ์ฝํ ์ธ ๋ ์ง์๋ฉ๋๋ค. | ||
|
||
```js | ||
// ์์ ์ฝ๋ ์ค๋ํซ. | ||
``` | ||
|
||
</Aside> | ||
|
||
<Aside type="danger">๋น๋ฐ๋ฒํธ๋ฅผ ๋ค๋ฅธ ์ฌ๋์๊ฒ ์๋ ค์ฃผ์ง ๋ง์ธ์.</Aside> | ||
```` | ||
|
||
<Fragment slot="markdoc"> | ||
|
||
````markdoc | ||
{% aside %} | ||
๋ณด์กฐ ๋ด์ฉ์ ์ฝํ ์ธ ์ ๋๋ค. | ||
{% /aside %} | ||
{% aside type="caution" %} | ||
๋ช ๊ฐ์ง ์ฃผ์ํด์ผ ํ ๋ด์ฉ์ ๋๋ค. | ||
{% /aside %} | ||
{% aside type="tip" %} | ||
๋ณด์กฐ ๋ด์ฉ์๋ ๋ค๋ฅธ ์ฝํ ์ธ ๋ ์ง์๋ฉ๋๋ค. | ||
```js | ||
// ์์ ์ฝ๋ ์ค๋ํซ. | ||
``` | ||
{% /aside %} | ||
{% aside type="danger" %} | ||
๋น๋ฐ๋ฒํธ๋ฅผ ๋ค๋ฅธ ์ฌ๋์๊ฒ ์๋ ค์ฃผ์ง ๋ง์ธ์. | ||
{% /aside %} | ||
```` | ||
|
||
</Fragment> | ||
|
||
<Fragment slot="preview"> | ||
|
||
<Aside>๋ณด์กฐ ๋ด์ฉ์ ์ฝํ ์ธ ์ ๋๋ค.</Aside> | ||
|
||
<Aside type="caution">๋ช ๊ฐ์ง ์ฃผ์ํด์ผ ํ ๋ด์ฉ์ ๋๋ค.</Aside> | ||
|
||
<Aside type="tip"> | ||
|
||
๋ณด์กฐ ๋ด์ฉ์๋ ๋ค๋ฅธ ์ฝํ ์ธ ๋ ์ง์๋ฉ๋๋ค. | ||
|
||
```js | ||
// ์์ ์ฝ๋ ์ค๋ํซ. | ||
``` | ||
|
||
</Aside> | ||
|
||
<Aside type="danger">๋น๋ฐ๋ฒํธ๋ฅผ ๋ค๋ฅธ ์ฌ๋์๊ฒ ์๋ ค์ฃผ์ง ๋ง์ธ์.</Aside> | ||
|
||
</Fragment> | ||
|
||
</Preview> | ||
|
||
Starlight๋ ๋ํ `<Aside>` ์ปดํฌ๋ํธ์ ๋์์ผ๋ก Markdown ๋ฐ MDX์์ ๋ณด์กฐ ๋ด์ฉ์ ๋ ๋๋งํ๊ธฐ ์ํ ์ฌ์ฉ์ ์ ์ ๊ตฌ๋ฌธ์ ์ ๊ณตํฉ๋๋ค. | ||
์ฌ์ฉ์ ์ ์ ๊ตฌ๋ฌธ์ ๋ํ ์์ธํ ๋ด์ฉ์ [โMarkdown์์ ์ฝํ ์ธ ์์ฑํ๊ธฐโ](/ko/guides/authoring-content/#๋ณด์กฐ-๋ด์ฉ) ๊ฐ์ด๋๋ฅผ ์ฐธ์กฐํ์ธ์. | ||
|
||
### ์ฌ์ฉ์ ์ ์ ์ ๋ชฉ ์ฌ์ฉ | ||
|
||
[`title`](#title) ์์ฑ์ ์ฌ์ฉํ์ฌ ๋ณด์กฐ ๋ด์ฉ์ ๊ธฐ๋ณธ ์ ๋ชฉ์ ์ฌ์ ์ํฉ๋๋ค. | ||
|
||
<Preview> | ||
|
||
```mdx 'title="์กฐ์ฌํ์ธ์!"' | ||
import { Aside } from '@astrojs/starlight/components'; | ||
|
||
<Aside type="caution" title="์กฐ์ฌํ์ธ์!"> | ||
์ฌ์ฉ์ ์ ์ ์ ๋ชฉ์ *์ฌ์ฉํ๋* ๊ฒฝ๊ณ ๋ณด์กฐ ๋ด์ฉ์ ๋๋ค. | ||
</Aside> | ||
``` | ||
|
||
<Fragment slot="markdoc"> | ||
|
||
```markdoc 'title="์กฐ์ฌํ์ธ์!"' | ||
{% aside type="caution" title="์กฐ์ฌํ์ธ์!" %} | ||
์ฌ์ฉ์ ์ ์ ์ ๋ชฉ์ *์ฌ์ฉํ๋* ๊ฒฝ๊ณ ๋ณด์กฐ ๋ด์ฉ์ ๋๋ค. | ||
{% /aside %} | ||
``` | ||
|
||
</Fragment> | ||
|
||
<Aside slot="preview" type="caution" title="์กฐ์ฌํ์ธ์!"> | ||
์ฌ์ฉ์ ์ ์ ์ ๋ชฉ์ *์ฌ์ฉํ๋* ๊ฒฝ๊ณ ๋ณด์กฐ ๋ด์ฉ์ ๋๋ค. | ||
</Aside> | ||
|
||
</Preview> | ||
|
||
## `<Aside>` ์์ฑ | ||
|
||
**๊ตฌํ:** [`Aside.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/user-components/Aside.astro) | ||
|
||
`<Aside>` ์ปดํฌ๋ํธ๋ ๋ค์๊ณผ ๊ฐ์ ์์ฑ์ ํ์ฉํฉ๋๋ค: | ||
|
||
### `type` | ||
|
||
**ํ์ :** `'note' | 'tip' | 'caution' | 'danger'` | ||
**๊ธฐ๋ณธ๊ฐ:** `'note'` | ||
|
||
ํ์ํ ๋ณด์กฐ ๋ด์ฉ์ ์ ํ์ ๋๋ค: | ||
|
||
- `note` ๋ณด์กฐ ๋ด์ฉ์ ํ๋์์ด๋ฉฐ ์ ๋ณด ์์ด์ฝ์ ํ์ํฉ๋๋ค (๊ธฐ๋ณธ๊ฐ). | ||
- `tip` ๋ณด์กฐ ๋ด์ฉ์ ๋ณด๋ผ์์ด๋ฉฐ ๋ก์ผ ์์ด์ฝ์ ํ์ํฉ๋๋ค. | ||
- `caution` ๋ณด์กฐ ๋ด์ฉ์ ๋ ธ๋์์ด๋ฉฐ ์ผ๊ฐํ ๊ฒฝ๊ณ ์์ด์ฝ์ ํ์ํฉ๋๋ค. | ||
- `danger` ๋ณด์กฐ ๋ด์ฉ์ ๋นจ๊ฐ์์ด๋ฉฐ ํ๊ฐํ ๊ฒฝ๊ณ ์์ด์ฝ์ ํ์ํฉ๋๋ค. | ||
|
||
### `title` | ||
|
||
**ํ์ :** `string` | ||
|
||
ํ์ํ ๋ณด์กฐ ๋ด์ฉ์ ์ ๋ชฉ์ ๋๋ค. | ||
`title`์ด ์ค์ ๋์ด ์์ง ์์ผ๋ฉด ํ์ฌ ๋ณด์กฐ ๋ด์ฉ์ `type`์ด ๊ธฐ๋ณธ ์ ๋ชฉ์ผ๋ก ์ฌ์ฉ๋ฉ๋๋ค. |
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