diff options
author | Junseong Park | 2025-04-16 21:00:37 +0900 |
---|---|---|
committer | GitHub | 2025-04-16 14:00:37 +0200 |
commit | d3340d4a28673fec5700c31f9505ddb9e2a40cce (patch) | |
tree | b00a3fecb3003a1a476319aaa1637405f846da98 | |
parent | 3cd02f3b1cf8fac79341de61fb18fd9951b1d261 (diff) | |
download | IT.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.mdx | 18 | ||||
-rw-r--r-- | docs/src/content/docs/ko/guides/pages.mdx | 61 | ||||
-rw-r--r-- | docs/src/content/docs/ko/reference/configuration.mdx | 23 |
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` |