diff options
author | Junseong Park | 2024-03-02 21:45:15 +0900 |
---|---|---|
committer | GitHub | 2024-03-02 13:45:15 +0100 |
commit | 93914c872b1e8f4facb00debdfa20850107d29c1 (patch) | |
tree | 2aac9bbe6405cf8bdae30ab4cf4b4358ad688138 | |
parent | 36cd40d4b5c51bb49f83674a269fcfec603f7b7f (diff) | |
download | IT.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.mdx | 173 |
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/#λ체-μ½ν
μΈ )λ₯Ό μ¬μ©νκ³ μλμ§ νμν©λλ€. |