summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunseong Park2024-03-02 21:45:15 +0900
committerGitHub2024-03-02 13:45:15 +0100
commit93914c872b1e8f4facb00debdfa20850107d29c1 (patch)
tree2aac9bbe6405cf8bdae30ab4cf4b4358ad688138
parent36cd40d4b5c51bb49f83674a269fcfec603f7b7f (diff)
downloadIT.starlight-93914c872b1e8f4facb00debdfa20850107d29c1.tar.gz
IT.starlight-93914c872b1e8f4facb00debdfa20850107d29c1.tar.bz2
IT.starlight-93914c872b1e8f4facb00debdfa20850107d29c1.zip
i18n(ko-KR): add `pages.mdx` (#1583)
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
-rw-r--r--docs/src/content/docs/ko/guides/pages.mdx173
1 files changed, 173 insertions, 0 deletions
diff --git a/docs/src/content/docs/ko/guides/pages.mdx b/docs/src/content/docs/ko/guides/pages.mdx
new file mode 100644
index 00000000..142a58cf
--- /dev/null
+++ b/docs/src/content/docs/ko/guides/pages.mdx
@@ -0,0 +1,173 @@
+---
+title: νŽ˜μ΄μ§€
+description: Starlightλ₯Ό μ‚¬μš©ν•˜μ—¬ λ¬Έμ„œ μ‚¬μ΄νŠΈμ˜ νŽ˜μ΄μ§€λ₯Ό λ§Œλ“€κ³  κ΄€λ¦¬ν•˜λŠ” 방법을 μ•Œμ•„λ³΄μ„Έμš”.
+sidebar:
+ order: 1
+---
+
+StarlightλŠ” Markdown Frontmatterλ₯Ό 톡해 μ œκ³΅λ˜λŠ” μœ μ—°ν•œ μ˜΅μ…˜μ„ μ‚¬μš©ν•˜μ—¬ μ½˜ν…μΈ λ₯Ό 기반으둜 μ‚¬μ΄νŠΈμ˜ HTML νŽ˜μ΄μ§€λ₯Ό μƒμ„±ν•©λ‹ˆλ‹€.
+λ˜ν•œ Starlight ν”„λ‘œμ νŠΈλŠ” [Astro의 κ°•λ ₯ν•œ νŽ˜μ΄μ§€ 생성 도ꡬ](https://docs.astro.build/ko/basics/astro-pages/)에 λŒ€ν•œ 전체 μ•‘μ„ΈμŠ€ κΆŒν•œμ„ κ°–μŠ΅λ‹ˆλ‹€.
+이 κ°€μ΄λ“œμ—μ„œλŠ” Starlightμ—μ„œ νŽ˜μ΄μ§€ 생성이 μž‘λ™ν•˜λŠ” 방식을 λ³΄μ—¬μ€λ‹ˆλ‹€.
+
+## μ½˜ν…μΈ  νŽ˜μ΄μ§€
+
+### 파일 ν˜•μ‹
+
+StarlightλŠ” ꡬ성이 ν•„μš” μ—†λŠ” Markdown 및 MDX μ½˜ν…μΈ  μž‘μ„±μ„ μ§€μ›ν•©λ‹ˆλ‹€.
+μ‹€ν—˜μ μΈ [Astro Markdoc 톡합](https://docs.astro.build/ko/guides/integrations-guide/markdoc/)을 μ„€μΉ˜ν•˜μ—¬ Markdoc에 λŒ€ν•œ 지원을 μΆ”κ°€ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
+
+### νŽ˜μ΄μ§€ μΆ”κ°€
+
+`src/content/docs/`에 `.md` λ˜λŠ” `.mdx` νŒŒμΌμ„ μƒμ„±ν•˜μ—¬ μ‚¬μ΄νŠΈμ— μƒˆ νŽ˜μ΄μ§€λ₯Ό μΆ”κ°€ν•˜μ„Έμš”.
+ν•˜μœ„ 폴더λ₯Ό μ‚¬μš©ν•˜μ—¬ νŒŒμΌμ„ μ •λ¦¬ν•˜κ³  μ—¬λŸ¬ 경둜 μ„Έκ·Έλ¨ΌνŠΈλ₯Ό μƒμ„±ν•˜μ„Έμš”.
+
+예λ₯Ό λ“€μ–΄, λ‹€μŒ 파일 κ΅¬μ‘°λŠ” `example.com/hello-world` 및 `example.com/reference/faq`에 νŽ˜μ΄μ§€λ₯Ό μƒμ„±ν•©λ‹ˆλ‹€.
+
+import FileTree from '~/components/file-tree.astro';
+
+<FileTree>
+
+- src/
+ - content/
+ - docs/
+ - hello-world.md
+ - reference/
+ - faq.md
+
+</FileTree>
+
+### νƒ€μž… μ•ˆμ •μ„±μ„ κ°–μΆ˜ ν”„λ‘ νŠΈλ§€ν„°
+
+λͺ¨λ“  Starlight νŽ˜μ΄μ§€λŠ” νŽ˜μ΄μ§€ ν‘œμ‹œ 방법을 μ œμ–΄ν•˜κΈ° μœ„ν•΄ μ‚¬μš©μž μ •μ˜ κ°€λŠ₯ν•œ [곡톡 ν”„λ‘ νŠΈλ§€ν„° 속성 μ„ΈνŠΈ](/ko/reference/frontmatter/)λ₯Ό κ³΅μœ ν•©λ‹ˆλ‹€.
+
+```md
+---
+title: μ•ˆλ…•ν•˜μ„Έμš”!
+description: 이것은 λ‚΄ Starlight 기반 μ‚¬μ΄νŠΈμ˜ νŽ˜μ΄μ§€μž…λ‹ˆλ‹€.
+---
+```
+
+μ€‘μš”ν•œ 사항을 μžŠμ–΄λ²„λ¦¬λ©΄ Starlightκ°€ μ•Œλ €λ“œλ¦½λ‹ˆλ‹€.
+
+## μ‚¬μš©μž μ •μ˜ νŽ˜μ΄μ§€
+
+κ³ κΈ‰ μ‚¬μš© μ‚¬λ‘€μ˜ 경우 `src/pages/` 디렉터리λ₯Ό μƒμ„±ν•˜μ—¬ μ‚¬μš©μž μ •μ˜ νŽ˜μ΄μ§€λ₯Ό μΆ”κ°€ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
+`src/pages/` λ””λ ‰ν„°λ¦¬λŠ” [Astro의 파일 기반 λΌμš°νŒ…](https://docs.astro.build/ko/basics/astro-pages/#파일-기반-λΌμš°νŒ…)을 μ‚¬μš©ν•˜λ©° λ‹€λ₯Έ νŽ˜μ΄μ§€ ν˜•μ‹μ—μ„œ `.astro` νŒŒμΌμ— λŒ€ν•œ 지원을 ν¬ν•¨ν•©λ‹ˆλ‹€.
+μ΄λŠ” μ™„μ „νžˆ μ‚¬μš©μž μ •μ˜λœ λ ˆμ΄μ•„μ›ƒμœΌλ‘œ νŽ˜μ΄μ§€λ₯Ό μž‘μ„±ν•˜κ±°λ‚˜ λŒ€μ²΄ 데이터 μ†ŒμŠ€μ—μ„œ νŽ˜μ΄μ§€λ₯Ό 생성해야 ν•˜λŠ” κ²½μš°μ— μœ μš©ν•©λ‹ˆλ‹€.
+
+예λ₯Ό λ“€μ–΄, 이 ν”„λ‘œμ νŠΈλŠ” `src/content/docs/`의 Markdown μ½˜ν…μΈ λ₯Ό `src/pages/`의 Astro 및 HTML κ²½λ‘œμ™€ ν˜Όν•©ν•©λ‹ˆλ‹€.
+
+<FileTree>
+
+- src/
+ - content/
+ - docs/
+ - hello-world.md
+ - pages/
+ - custom.astro
+ - archived.html
+
+</FileTree>
+
+[Astro λ¬Έμ„œμ˜ "νŽ˜μ΄μ§€" κ°€μ΄λ“œ](https://docs.astro.build/ko/basics/astro-pages/)μ—μ„œ μžμ„Έν•œ λ‚΄μš©μ„ μ½μ–΄λ³΄μ„Έμš”.
+
+### μ‚¬μš©μž μ •μ˜ νŽ˜μ΄μ§€μ—μ„œ Starlight λ””μžμΈ μ‚¬μš©
+
+μ‚¬μš©μž μ •μ˜ νŽ˜μ΄μ§€μ—μ„œ Starlight λ ˆμ΄μ•„μ›ƒμ„ μ‚¬μš©ν•˜λ €λ©΄ `<StarlightPage />` μ»΄ν¬λ„ŒνŠΈλ‘œ νŽ˜μ΄μ§€ μ½˜ν…μΈ λ₯Ό κ°μ‹Έμ„Έμš”.
+μ΄λŠ” μ½˜ν…μΈ λ₯Ό λ™μ μœΌλ‘œ μƒμ„±ν•˜μ§€λ§Œ μ—¬μ „νžˆ Starlight의 λ””μžμΈμ„ μ‚¬μš©ν•˜λ €λŠ” 경우 μœ μš©ν•  수 μžˆμŠ΅λ‹ˆλ‹€.
+
+```astro
+---
+// src/pages/custom-page/example.astro
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import CustomComponent from './CustomComponent.astro';
+---
+
+<StarlightPage frontmatter={{ title: 'μ‚¬μš©μž μ •μ˜ νŽ˜μ΄μ§€' }}>
+ <p>이것은 μ‚¬μš©μž μ •μ˜ μ»΄ν¬λ„ŒνŠΈκ°€ μžˆλŠ” μ‚¬μš©μž μ •μ˜ νŽ˜μ΄μ§€μž…λ‹ˆλ‹€.</p>
+ <CustomComponent />
+</StarlightPage>
+```
+
+#### Props
+
+`<StarlightPage />` μ»΄ν¬λ„ŒνŠΈλŠ” λ‹€μŒ propsλ₯Ό ν—ˆμš©ν•©λ‹ˆλ‹€.
+
+##### `frontmatter` (ν•„μˆ˜)
+
+**νƒ€μž…:** `StarlightPageFrontmatter`
+
+Markdown νŽ˜μ΄μ§€μ˜ ν”„λ‘ νŠΈλ§€ν„°μ™€ μœ μ‚¬ν•˜κ²Œ 이 νŽ˜μ΄μ§€μ— λŒ€ν•œ [ν”„λ‘ νŠΈλ§€ν„° 속성](/ko/reference/frontmatter/)을 μ„€μ •ν•©λ‹ˆλ‹€.
+[`title`](/ko/reference/frontmatter/#title-ν•„μˆ˜) 속성은 ν•„μˆ˜μ΄λ©° λ‹€λ₯Έ λͺ¨λ“  속성은 선택 μ‚¬ν•­μž…λ‹ˆλ‹€.
+
+λ‹€μŒ 속성은 Markdown ν”„λ‘ νŠΈλ§€ν„°μ™€ λ‹€λ¦…λ‹ˆλ‹€.
+
+- [`slug`](/ko/reference/frontmatter/#slug) 속성은 μ§€μ›λ˜μ§€ μ•ŠμœΌλ©° μ‚¬μš©μž μ •μ˜ νŽ˜μ΄μ§€μ˜ URL을 기반으둜 μžλ™ μ„€μ •λ©λ‹ˆλ‹€.
+- [`editUrl`](/ko/reference/frontmatter/#editurl) μ˜΅μ…˜μ—λŠ” νŽΈμ§‘ 링크λ₯Ό ν‘œμ‹œν•˜κΈ° μœ„ν•œ URL이 ν•„μš”ν•©λ‹ˆλ‹€.
+- [μžλ™ μƒμ„±λœ 링크 κ·Έλ£Ή](/ko/reference/configuration/#sidebar)μ—μ„œ νŽ˜μ΄μ§€κ°€ ν‘œμ‹œλ˜λŠ” 방식을 μ‚¬μš©μž μ •μ˜ν•˜κΈ° μœ„ν•œ [`sidebar`](/ko/reference/frontmatter/#sidebar) ν”„λ‘ νŠΈλ§€ν„° 속성을 μ‚¬μš©ν•  수 μ—†μŠ΅λ‹ˆλ‹€. `<StarlightPage />` μ»΄ν¬λ„ŒνŠΈλ₯Ό μ‚¬μš©ν•˜λŠ” νŽ˜μ΄μ§€λŠ” μ»¬λ ‰μ…˜μ˜ 일뢀가 μ•„λ‹ˆλ©° μžλ™ μƒμ„±λœ μ‚¬μ΄λ“œλ°” 그룹에 좔가될 수 μ—†μŠ΅λ‹ˆλ‹€.
+
+##### `sidebar`
+
+**νƒ€μž…:** `SidebarEntry[]`
+**κΈ°λ³Έκ°’:** [μ „μ—­ `sidebar` ꡬ성](/ko/reference/configuration/#sidebar)을 기반으둜 μƒμ„±λœ μ‚¬μ΄λ“œλ°”
+
+이 νŽ˜μ΄μ§€μ— λŒ€ν•œ μ‚¬μš©μž μ •μ˜ μ‚¬μ΄νŠΈ 탐색 μ‚¬μ΄λ“œλ°”λ₯Ό μ œκ³΅ν•©λ‹ˆλ‹€.
+μ„€μ •ν•˜μ§€ μ•ŠμœΌλ©΄ νŽ˜μ΄μ§€μ—μ„œ κΈ°λ³Έ μ „μ—­ μ‚¬μ΄λ“œλ°”λ₯Ό μ‚¬μš©ν•©λ‹ˆλ‹€.
+
+예λ₯Ό λ“€μ–΄, λ‹€μŒ νŽ˜μ΄μ§€λŠ” ν™ˆνŽ˜μ΄μ§€ 링크와 λ‹€μ–‘ν•œ λ³„μžλ¦¬μ— λŒ€ν•œ 링크 그룹으둜 κΈ°λ³Έ μ‚¬μ΄λ“œλ°”λ₯Ό μž¬μ •μ˜ν•©λ‹ˆλ‹€.
+μ‚¬μ΄λ“œλ°”μ˜ ν˜„μž¬ νŽ˜μ΄μ§€λŠ” `isCurrent` 속성을 μ‚¬μš©ν•˜μ—¬ μ„€μ •λ˜μ—ˆμœΌλ©° 선택적인 `badge`κ°€ 링크 ν•­λͺ©μ— μΆ”κ°€λ˜μ—ˆμŠ΅λ‹ˆλ‹€.
+
+```astro {3-13}
+<StarlightPage
+ frontmatter={{ title: '였리온' }}
+ sidebar={[
+ { label: 'ν™ˆ', href: '/' },
+ {
+ label: 'λ³„μžλ¦¬',
+ items: [
+ { label: 'μ•ˆλ“œλ‘œλ©”λ‹€', href: '/andromeda/' },
+ { label: '였리온', href: '/orion/', isCurrent: true },
+ { label: 'μž‘μ€κ³°μžλ¦¬', href: '/ursa-minor/', badge: 'Stub' },
+ ],
+ },
+ ]}
+>
+ μ˜ˆμ‹œ μ½˜ν…μΈ 
+</StarlightPage>
+```
+
+##### `hasSidebar`
+
+**νƒ€μž…:** `boolean`
+**κΈ°λ³Έκ°’:** [`frontmatter.template`](/ko/reference/frontmatter/#template)의 값이 `'splash'`라면 `false`, κ·Έλ ‡μ§€ μ•Šλ‹€λ©΄ `true`
+
+이 νŽ˜μ΄μ§€μ— μ‚¬μ΄λ“œλ°”λ₯Ό ν‘œμ‹œν• μ§€ μ—¬λΆ€λ₯Ό μ œμ–΄ν•©λ‹ˆλ‹€.
+
+##### `headings`
+
+**νƒ€μž…:** `{ depth: number; slug: string; text: string }[]`
+**κΈ°λ³Έκ°’:** `[]`
+
+이 νŽ˜μ΄μ§€μ˜ λͺ¨λ“  제λͺ© 배열을 μ œκ³΅ν•˜μ„Έμš”.
+제곡된 경우 StarlightλŠ” 이 제λͺ©μ—μ„œ νŽ˜μ΄μ§€ λͺ©μ°¨λ₯Ό μƒμ„±ν•©λ‹ˆλ‹€.
+
+##### `dir`
+
+**νƒ€μž…:** `'ltr' | 'rtl'`
+**κΈ°λ³Έκ°’:** ν˜„μž¬ λ‘œμΌ€μΌμ˜ μ“°κΈ° λ°©ν–₯
+
+이 νŽ˜μ΄μ§€ μ½˜ν…μΈ μ˜ μ“°κΈ° λ°©ν–₯을 μ„€μ •ν•©λ‹ˆλ‹€.
+
+##### `lang`
+
+**νƒ€μž…:** `string`
+**κΈ°λ³Έκ°’:** ν˜„μž¬ λ‘œμΌ€μΌμ˜ μ–Έμ–΄
+
+이 νŽ˜μ΄μ§€ μ½˜ν…μΈ μ— λŒ€ν•΄ BCP-47 μ–Έμ–΄ νƒœκ·Έλ₯Ό μ„€μ •ν•©λ‹ˆλ‹€. 예: `en`, `zh-CN` λ˜λŠ” `pt-BR`.
+
+##### `isFallback`
+
+**νƒ€μž…:** `boolean`
+**κΈ°λ³Έκ°’:** `false`
+
+ν˜„μž¬ 언어에 λŒ€ν•œ λ²ˆμ—­μ΄ μ‘΄μž¬ν•˜μ§€ μ•Šμ•„ 이 νŽ˜μ΄μ§€κ°€ [λŒ€μ²΄ μ½˜ν…μΈ ](/ko/guides/i18n/#λŒ€μ²΄-μ½˜ν…μΈ )λ₯Ό μ‚¬μš©ν•˜κ³  μžˆλŠ”μ§€ ν‘œμ‹œν•©λ‹ˆλ‹€.