Skip to content

Commit

Permalink
i18n(ko-KR): create asides.mdx and update authoring-content.mdx (#โ€ฆ
Browse files Browse the repository at this point in the history
โ€ฆ2339)

Co-authored-by: HiDeoo <[email protected]>
  • Loading branch information
jsparkdev and HiDeoo authored Sep 18, 2024
1 parent 6db95a2 commit b179f54
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 9 deletions.
158 changes: 158 additions & 0 deletions docs/src/content/docs/ko/components/asides.mdx
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`์ด ๊ธฐ๋ณธ ์ œ๋ชฉ์œผ๋กœ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.
18 changes: 9 additions & 9 deletions docs/src/content/docs/ko/guides/authoring-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@ description: Starlight์— ๋‚ด์žฅ๋œ ๋งํฌ๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๋ฐฉ๋ฒ•

[Astro ๊ณต์‹ ๋ฌธ์„œ](https://docs.astro.build/ko/guides/markdown-content/#heading-ids)์—์„œ Astro๊ฐ€ ์ œ๋ชฉ์˜ `id`๋ฅผ ์ฒ˜๋ฆฌํ•˜๋Š” ๋ฐฉ๋ฒ•์— ๋Œ€ํ•ด ์ž์„ธํžˆ ์•Œ์•„๋ณด์„ธ์š”.

## ์ฃผ์„
## ๋ณด์กฐ ๋‚ด์šฉ

์ฃผ์„์€ "admonitions" ๋˜๋Š” "callouts" ๋ผ๊ณ ๋„ ํ•˜๋ฉฐ, ํŽ˜์ด์ง€์˜ ๊ธฐ๋ณธ ์ฝ˜ํ…์ธ  ์ฃผ๋ณ€์— ๋ณด์กฐ ์ •๋ณด๋ฅผ ํ‘œ์‹œํ•˜๋Š” ๋ฐ ์œ ์šฉํ•ฉ๋‹ˆ๋‹ค.
๋ณด์กฐ ๋‚ด์šฉ์€ "admonitions" ๋˜๋Š” "callouts" ๋ผ๊ณ ๋„ ํ•˜๋ฉฐ, ํŽ˜์ด์ง€์˜ ๊ธฐ๋ณธ ์ฝ˜ํ…์ธ  ์ฃผ๋ณ€์— ๋ณด์กฐ ์ •๋ณด๋ฅผ ํ‘œ์‹œํ•˜๋Š” ๋ฐ ์œ ์šฉํ•ฉ๋‹ˆ๋‹ค.

Starlight๋Š” ์ฃผ์„ ๋ Œ๋”๋ง์„ ์œ„ํ•œ ์‚ฌ์šฉ์ž ์ •์˜ Markdown ๊ตฌ๋ฌธ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. ์ฃผ์„ ๋ธ”๋ก์€ ๋‚ด์šฉ์„ ๊ฐ์‹ธ๊ธฐ ์œ„ํ•ด ์„ธ ๊ฐœ์˜ ์ฝœ๋ก  `:::`์„ ์‚ฌ์šฉํ•˜๋ฉฐ `note`, `tip`, `caution` ๋˜๋Š” `danger` ํƒ€์ž…์ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
Starlight๋Š” ๋ณด์กฐ ๋‚ด์šฉ ๋ Œ๋”๋ง์„ ์œ„ํ•œ ์‚ฌ์šฉ์ž ์ •์˜ Markdown ๊ตฌ๋ฌธ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. ๋ณด์กฐ ๋‚ด์šฉ ๋ธ”๋ก์€ ๋‚ด์šฉ์„ ๊ฐ์‹ธ๊ธฐ ์œ„ํ•ด ์„ธ ๊ฐœ์˜ ์ฝœ๋ก  `:::`์„ ์‚ฌ์šฉํ•˜๋ฉฐ `note`, `tip`, `caution` ๋˜๋Š” `danger` ํƒ€์ž…์ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋‹ค๋ฅธ Markdown ์ฝ˜ํ…์ธ ๋ฅผ ์ฃผ์„ ์•ˆ์— ์ค‘์ฒฉ์‹œํ‚ฌ ์ˆ˜๋„ ์žˆ์ง€๋งŒ ์งง๊ณ  ๊ฐ„๊ฒฐํ•œ ์ฝ˜ํ…์ธ  ๋ฉ์–ด๋ฆฌ์— ๊ฐ€์žฅ ์ ํ•ฉํ•ฉ๋‹ˆ๋‹ค.
๋‹ค๋ฅธ Markdown ์ฝ˜ํ…์ธ ๋ฅผ ๋ณด์กฐ ๋‚ด์šฉ ์•ˆ์— ์ค‘์ฒฉ์‹œํ‚ฌ ์ˆ˜๋„ ์žˆ์ง€๋งŒ ์งง๊ณ  ๊ฐ„๊ฒฐํ•œ ์ฝ˜ํ…์ธ  ๋ฉ์–ด๋ฆฌ์— ๊ฐ€์žฅ ์ ํ•ฉํ•ฉ๋‹ˆ๋‹ค.

### Note ์ฃผ์„
### Note ๋ณด์กฐ ๋‚ด์šฉ

:::note

Expand All @@ -138,9 +138,9 @@ npm create astro@latest -- --template starlight
:::
````

### ์‚ฌ์šฉ์ž ์ •์˜ ์ฃผ์„ ์ œ๋ชฉ
### ์‚ฌ์šฉ์ž ์ •์˜ ๋ณด์กฐ ๋‚ด์šฉ ์ œ๋ชฉ

์ฃผ์„ ํƒ€์ž… ๋‹ค์Œ์— ๋Œ€๊ด„ํ˜ธ๋ฅผ ์‚ฌ์šฉํ•ด ์ฃผ์„์˜ ์ œ๋ชฉ์„ ์ง€์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. `:::tip[์•Œ๊ณ  ๊ณ„์…จ๋‚˜์š”?]`
๋ณด์กฐ ๋‚ด์šฉ ํƒ€์ž… ๋‹ค์Œ์— ๋Œ€๊ด„ํ˜ธ๋ฅผ ์‚ฌ์šฉํ•ด ๋ณด์กฐ ๋‚ด์šฉ์˜ ์ œ๋ชฉ์„ ์ง€์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. `:::tip[์•Œ๊ณ  ๊ณ„์…จ๋‚˜์š”?]`

:::tip[์•Œ๊ณ  ๊ณ„์…จ๋‚˜์š”?]

Expand All @@ -153,9 +153,9 @@ Astro๋Š” ["Islands Architecture"](https://docs.astro.build/ko/concepts/islands/)
:::
```

### ๋” ๋งŽ์€ ์ฃผ์„ ํƒ€์ž…
### ๋” ๋งŽ์€ ๋ณด์กฐ ๋‚ด์šฉ ํƒ€์ž…

Caution๊ณผ Danger ์ฃผ์„์€ ์‹ค์ˆ˜ํ•˜๊ธฐ ์‰ฌ์šด ์„ธ๋ถ€ ์‚ฌํ•ญ์— ๋Œ€ํ•ด ์‚ฌ์šฉ์ž๋ฅผ ์ง‘์ค‘์‹œํ‚ค๋Š” ๋ฐ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ๊ธฐ๋Šฅ์„ ๋งŽ์ด ์‚ฌ์šฉํ•˜๊ณ  ์žˆ๋‹ค๋ฉด, ๋ฌธ์„œํ™”์ค‘์ธ ๋‚ด์šฉ์„ ๋‹ค์‹œ ๋””์ž์ธํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.
Caution๊ณผ Danger ๋ณด์กฐ ๋‚ด์šฉ์€ ์‹ค์ˆ˜ํ•˜๊ธฐ ์‰ฌ์šด ์„ธ๋ถ€ ์‚ฌํ•ญ์— ๋Œ€ํ•ด ์‚ฌ์šฉ์ž๋ฅผ ์ง‘์ค‘์‹œํ‚ค๋Š” ๋ฐ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค. ์ด๋Ÿฌํ•œ ๊ธฐ๋Šฅ์„ ๋งŽ์ด ์‚ฌ์šฉํ•˜๊ณ  ์žˆ๋‹ค๋ฉด, ๋ฌธ์„œํ™”์ค‘์ธ ๋‚ด์šฉ์„ ๋‹ค์‹œ ๋””์ž์ธํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.

:::caution
๋‹น์‹ ์ด ๋ฉ‹์ง„ ๋ฌธ์„œ ์‚ฌ์ดํŠธ๋ฅผ ์›ํ•˜์ง€ ์•Š๋Š”๋‹ค๋ฉด [Starlight](/ko/)๋Š” ํ•„์š”ํ•˜์ง€ ์•Š์„ ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค.
Expand Down

0 comments on commit b179f54

Please sign in to comment.