summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunseong Park2025-04-16 21:00:37 +0900
committerGitHub2025-04-16 14:00:37 +0200
commitd3340d4a28673fec5700c31f9505ddb9e2a40cce (patch)
treeb00a3fecb3003a1a476319aaa1637405f846da98
parent3cd02f3b1cf8fac79341de61fb18fd9951b1d261 (diff)
downloadIT.starlight-d3340d4a28673fec5700c31f9505ddb9e2a40cce.tar.gz
IT.starlight-d3340d4a28673fec5700c31f9505ddb9e2a40cce.tar.bz2
IT.starlight-d3340d4a28673fec5700c31f9505ddb9e2a40cce.zip
i18n(ko-KR): update 3 Korean documents (#3127)
-rw-r--r--docs/src/content/docs/ko/guides/authoring-content.mdx18
-rw-r--r--docs/src/content/docs/ko/guides/pages.mdx61
-rw-r--r--docs/src/content/docs/ko/reference/configuration.mdx23
3 files changed, 98 insertions, 4 deletions
diff --git a/docs/src/content/docs/ko/guides/authoring-content.mdx b/docs/src/content/docs/ko/guides/authoring-content.mdx
index 57e49296..83c6f11e 100644
--- a/docs/src/content/docs/ko/guides/authoring-content.mdx
+++ b/docs/src/content/docs/ko/guides/authoring-content.mdx
@@ -647,3 +647,21 @@ yarn create astro --template starlight/markdoc
</Steps>
Markdoc ๊ตฌ๋ฌธ ๋ฐ ๊ธฐ๋Šฅ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ [Markdoc ๋ฌธ์„œ](https://markdoc.dev/docs/syntax) ๋˜๋Š” [Astro Markdoc ํ†ตํ•ฉ ๊ฐ€์ด๋“œ](https://docs.astro.build/ko/guides/integrations-guide/markdoc/)๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.
+
+### Markdoc ํ”„๋ฆฌ์…‹ ๊ตฌ์„ฑ
+
+๋‹ค์Œ์€ `starlightMarkdoc()` ํ”„๋ฆฌ์…‹์ด ํ—ˆ์šฉํ•˜๋Š” ๊ตฌ์„ฑ ์˜ต์…˜์ž…๋‹ˆ๋‹ค.
+
+#### `headingLinks`
+
+**ํƒ€์ž…:** `boolean`
+**๊ธฐ๋ณธ๊ฐ’:** `true`
+
+์ œ๋ชฉ์ด ํด๋ฆญ ๊ฐ€๋Šฅํ•œ ์•ต์ปค ๋งํฌ์™€ ํ•จ๊ป˜ ๋ Œ๋”๋ง๋ ์ง€ ์—ฌ๋ถ€๋ฅผ ์ œ์–ดํ•ฉ๋‹ˆ๋‹ค. Markdown ๋ฐ MDX ํŒŒ์ผ์— ์ ์šฉ๋˜๋Š” [`markdown.headingLinks`](/ko/reference/configuration/#markdown) ์˜ต์…˜๊ณผ ๋™์ผํ•ฉ๋‹ˆ๋‹ค.
+
+```js "headingLinks: false"
+export default defineMarkdocConfig({
+ // ๊ธฐ๋ณธ ์ œ๋ชฉ ์•ต์ปค ๋งํฌ ์ง€์›์„ ๋น„ํ™œ์„ฑํ™”ํ•ฉ๋‹ˆ๋‹ค.
+ extends: [starlightMarkdoc({ headingLinks: false })],
+});
+```
diff --git a/docs/src/content/docs/ko/guides/pages.mdx b/docs/src/content/docs/ko/guides/pages.mdx
index 705569d0..12ff5794 100644
--- a/docs/src/content/docs/ko/guides/pages.mdx
+++ b/docs/src/content/docs/ko/guides/pages.mdx
@@ -3,6 +3,8 @@ title: ํŽ˜์ด์ง€
description: Starlight๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๋ฌธ์„œ ์‚ฌ์ดํŠธ์˜ ํŽ˜์ด์ง€๋ฅผ ๋งŒ๋“ค๊ณ  ๊ด€๋ฆฌํ•˜๋Š” ๋ฐฉ๋ฒ•์„ ์•Œ์•„๋ณด์„ธ์š”.
sidebar:
order: 1
+tableOfContents:
+ maxHeadingLevel: 4
---
Starlight๋Š” Markdown Frontmatter๋ฅผ ํ†ตํ•ด ์ œ๊ณต๋˜๋Š” ์œ ์—ฐํ•œ ์˜ต์…˜์„ ์‚ฌ์šฉํ•˜์—ฌ ์ฝ˜ํ…์ธ ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ์‚ฌ์ดํŠธ์˜ HTML ํŽ˜์ด์ง€๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.
@@ -73,28 +75,49 @@ description: ์ด๊ฒƒ์€ ๋‚ด Starlight ๊ธฐ๋ฐ˜ ์‚ฌ์ดํŠธ์˜ ํŽ˜์ด์ง€์ž…๋‹ˆ๋‹ค.
### ์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€์—์„œ Starlight ๋””์ž์ธ ์‚ฌ์šฉ
-์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€์—์„œ Starlight ๋ ˆ์ด์•„์›ƒ์„ ์‚ฌ์šฉํ•˜๋ ค๋ฉด `<StarlightPage />` ์ปดํฌ๋„ŒํŠธ๋กœ ํŽ˜์ด์ง€ ์ฝ˜ํ…์ธ ๋ฅผ ๊ฐ์‹ธ์„ธ์š”.
+์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€์—์„œ Starlight ๋ ˆ์ด์•„์›ƒ์„ ์‚ฌ์šฉํ•˜๋ ค๋ฉด [`<StarlightPage>` ์ปดํฌ๋„ŒํŠธ](#starlightpage-์ปดํฌ๋„ŒํŠธ)๋กœ ํŽ˜์ด์ง€ ์ฝ˜ํ…์ธ ๋ฅผ ๊ฐ์‹ธ์„ธ์š”.
์ด๋Š” ์ฝ˜ํ…์ธ ๋ฅผ ๋™์ ์œผ๋กœ ์ƒ์„ฑํ•˜์ง€๋งŒ ์—ฌ์ „ํžˆ Starlight์˜ ๋””์ž์ธ์„ ์‚ฌ์šฉํ•˜๋ ค๋Š” ๊ฒฝ์šฐ ์œ ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
+์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€์—์„œ [`<AnchorHeading>` ์ปดํฌ๋„ŒํŠธ](#anchorheading-์ปดํฌ๋„ŒํŠธ)๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ Starlight์˜ Markdown ์•ต์ปค ๋งํฌ ์Šคํƒ€์ผ๊ณผ ์ผ์น˜ํ•˜๋Š” ์•ต์ปค ๋งํฌ๋ฅผ ์ œ๋ชฉ์— ์ถ”๊ฐ€ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
+
```astro
---
// src/pages/custom-page/example.astro
import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import AnchorHeading from '@astrojs/starlight/components/AnchorHeading.astro';
import CustomComponent from './CustomComponent.astro';
---
<StarlightPage frontmatter={{ title: '์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€' }}>
- <p>์ด๊ฒƒ์€ ์‚ฌ์šฉ์ž ์ •์˜ ์ปดํฌ๋„ŒํŠธ๊ฐ€ ์žˆ๋Š” ์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€์ž…๋‹ˆ๋‹ค.</p>
+ <p>์‚ฌ์šฉ์ž ์ •์˜ ์ปดํฌ๋„ŒํŠธ๊ฐ€ ์žˆ๋Š” ์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€์ž…๋‹ˆ๋‹ค.</p>
<CustomComponent />
+
+ <AnchorHeading level="2" id="learn-more">์ž์„ธํžˆ ์•Œ์•„๋ณด๊ธฐ</AnchorHeading>
+ <p>
+ <a href="https://starlight.astro.build/">Starlight ๋ฌธ์„œ์—์„œ ์ž์„ธํžˆ ์•Œ์•„๋ณด๊ธฐ</a>
+ </p>
</StarlightPage>
```
-#### Props
+#### `<StarlightPage>` ์ปดํฌ๋„ŒํŠธ
+
+`<StarlightPage />` ์ปดํฌ๋„ŒํŠธ๋Š” Starlight์˜ ๋ ˆ์ด์•„์›ƒ๊ณผ ์Šคํƒ€์ผ์„ ์‚ฌ์šฉํ•˜์—ฌ ์ „์ฒด ํŽ˜์ด์ง€ ์ฝ˜ํ…์ธ ๋ฅผ ๋ Œ๋”๋งํ•ฉ๋‹ˆ๋‹ค.
+
+```astro
+---
+import StarlightPage from '@astrojs/starlight/components/AnchorHeading.astro';
+---
+
+<StarlightPage frontmatter={{ title: '์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€' }}>
+ <!-- ์‚ฌ์šฉ์ž ์ •์˜ ํŽ˜์ด์ง€ ์ฝ˜ํ…์ธ  -->
+</StarlightPage>
+```
`<StarlightPage />` ์ปดํฌ๋„ŒํŠธ๋Š” ๋‹ค์Œ props๋ฅผ ํ—ˆ์šฉํ•ฉ๋‹ˆ๋‹ค.
-##### `frontmatter` (ํ•„์ˆ˜)
+##### `frontmatter`
+**ํ•„์ˆ˜**
**ํƒ€์ž…:** `StarlightPageFrontmatter`
Markdown ํŽ˜์ด์ง€์˜ ํ”„๋ก ํŠธ๋งคํ„ฐ์™€ ์œ ์‚ฌํ•˜๊ฒŒ ์ด ํŽ˜์ด์ง€์— ๋Œ€ํ•œ [ํ”„๋ก ํŠธ๋งคํ„ฐ ์†์„ฑ](/ko/reference/frontmatter/)์„ ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.
@@ -173,3 +196,33 @@ Markdown ํŽ˜์ด์ง€์˜ ํ”„๋ก ํŠธ๋งคํ„ฐ์™€ ์œ ์‚ฌํ•˜๊ฒŒ ์ด ํŽ˜์ด์ง€์— ๋Œ€ํ•œ [ํ
**๊ธฐ๋ณธ๊ฐ’:** `false`
ํ˜„์žฌ ์–ธ์–ด์— ๋Œ€ํ•œ ๋ฒˆ์—ญ์ด ์กด์žฌํ•˜์ง€ ์•Š์•„ ์ด ํŽ˜์ด์ง€๊ฐ€ [๋Œ€์ฒด ์ฝ˜ํ…์ธ ](/ko/guides/i18n/#๋Œ€์ฒด-์ฝ˜ํ…์ธ )๋ฅผ ์‚ฌ์šฉํ•˜๊ณ  ์žˆ๋Š”์ง€ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค.
+
+#### `<AnchorHeading>` ์ปดํฌ๋„ŒํŠธ
+
+`<AnchorHeading />` ์ปดํฌ๋„ŒํŠธ๋Š” Starlight์˜ Markdown ์Šคํƒ€์ผ๊ณผ ์ผ์น˜ํ•˜๋Š” ํด๋ฆญ ๊ฐ€๋Šฅํ•œ ์•ต์ปค ๋งํฌ๊ฐ€ ์žˆ๋Š” HTML ์ œ๋ชฉ ์š”์†Œ๋ฅผ ๋ Œ๋”๋งํ•ฉ๋‹ˆ๋‹ค.
+
+```astro
+---
+import AnchorHeading from '@astrojs/starlight/components/AnchorHeading.astro';
+---
+
+<AnchorHeading level="2" id="sub-heading">ํ•˜์œ„ ์ œ๋ชฉ</AnchorHeading>
+```
+
+์ด ์ปดํฌ๋„ŒํŠธ๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™์€ props ๋ฟ๋งŒ ์•„๋‹ˆ๋ผ ๋‹ค๋ฅธ ์œ ํšจํ•œ [์ „์—ญ HTML ์†์„ฑ](https://developer.mozilla.org/ko/docs/Web/HTML/Reference/Global_attributes)๋„ ํ—ˆ์šฉํ•ฉ๋‹ˆ๋‹ค.
+
+##### `level`
+
+**ํ•„์ˆ˜**
+**ํƒ€์ž…:** `1 | 2 | 3 | 4 | 5 | 6`
+
+๋ Œ๋”๋งํ•  ์ œ๋ชฉ ์ˆ˜์ค€์ž…๋‹ˆ๋‹ค.
+์˜ˆ๋ฅผ ๋“ค์–ด, `level="1"`์€ `<h1>` ์š”์†Œ๋ฅผ ๋ Œ๋”๋งํ•ฉ๋‹ˆ๋‹ค.
+
+##### `id`
+
+**ํ•„์ˆ˜**
+**ํƒ€์ž…:** `string`
+
+์ด ์ œ๋ชฉ์˜ ๊ณ ์œ  ID์ž…๋‹ˆ๋‹ค.
+์ด๋Š” ๋ Œ๋”๋ง๋œ ์ œ๋ชฉ์˜ `id` ์†์„ฑ์œผ๋กœ ์‚ฌ์šฉ๋˜๋ฉฐ, ์•ต์ปค ์•„์ด์ฝ˜์€ ์ด ID๋กœ ์—ฐ๊ฒฐ๋ฉ๋‹ˆ๋‹ค.
diff --git a/docs/src/content/docs/ko/reference/configuration.mdx b/docs/src/content/docs/ko/reference/configuration.mdx
index e73320a4..df71387d 100644
--- a/docs/src/content/docs/ko/reference/configuration.mdx
+++ b/docs/src/content/docs/ko/reference/configuration.mdx
@@ -377,6 +377,29 @@ starlight({
});
```
+### `markdown`
+
+**ํƒ€์ž…:** `{ headingLinks?: boolean }`
+**๊ธฐ๋ณธ๊ฐ’:** `{ headingLinks: true }`
+
+Starlight์˜ Markdown ์ฒ˜๋ฆฌ๋ฅผ ๊ตฌ์„ฑํ•ฉ๋‹ˆ๋‹ค.
+
+#### `headingLinks`
+
+**ํƒ€์ž…:** `boolean`
+**๊ธฐ๋ณธ๊ฐ’:** `true`
+
+์ œ๋ชฉ์ด ํด๋ฆญ ๊ฐ€๋Šฅํ•œ ์•ต์ปค ๋งํฌ์™€ ํ•จ๊ป˜ ๋ Œ๋”๋ง๋ ์ง€ ์—ฌ๋ถ€๋ฅผ ์ œ์–ดํ•ฉ๋‹ˆ๋‹ค.
+
+```js
+starlight({
+ markdown: {
+ // Starlight์˜ ํด๋ฆญ ๊ฐ€๋Šฅํ•œ ์ œ๋ชฉ ์•ต์ปค ๋งํฌ๋ฅผ ๋น„ํ™œ์„ฑํ™”ํ•ฉ๋‹ˆ๋‹ค.
+ headingLinks: false,
+ },
+}),
+```
+
### `expressiveCode`
**ํƒ€์ž…:** `StarlightExpressiveCodeOptions | boolean`