summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunseong Park2025-07-17 16:21:47 +0900
committerGitHub2025-07-17 09:21:47 +0200
commite327fa03240b33750b0fa502f844ed790737a508 (patch)
tree0599f4338c3d2b4f4278093d2f14bf32ae10f971
parent4963afb526ecedc08865d177539ac8f05d3f54e7 (diff)
downloadIT.starlight-e327fa03240b33750b0fa502f844ed790737a508.tar.gz
IT.starlight-e327fa03240b33750b0fa502f844ed790737a508.tar.bz2
IT.starlight-e327fa03240b33750b0fa502f844ed790737a508.zip
i18n(ko-KR): update `manual-setup.mdx`, `configuration.mdx` (#3322)
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
-rw-r--r--docs/src/content/docs/ko/manual-setup.mdx2
-rw-r--r--docs/src/content/docs/ko/reference/configuration.mdx120
2 files changed, 120 insertions, 2 deletions
diff --git a/docs/src/content/docs/ko/manual-setup.mdx b/docs/src/content/docs/ko/manual-setup.mdx
index 280090d0..bebae1ba 100644
--- a/docs/src/content/docs/ko/manual-setup.mdx
+++ b/docs/src/content/docs/ko/manual-setup.mdx
@@ -63,7 +63,7 @@ export default defineConfig({
Starlight๋Š” `src/content.config.ts` ํŒŒ์ผ์— ๊ตฌ์„ฑ๋œ Astro์˜ [์ฝ˜ํ…์ธ  ์ปฌ๋ ‰์…˜](https://docs.astro.build/ko/guides/content-collections/) ์œ„์— ๊ตฌ์ถ•๋˜์—ˆ์Šต๋‹ˆ๋‹ค.
-Starlight์˜ `docsLoader` ๋ฐ `docsSchema`๋ฅผ ์‚ฌ์šฉํ•˜๋Š” `docs` ์ปฌ๋ ‰์…˜์„ ์ถ”๊ฐ€ํ•˜์—ฌ ์ฝ˜ํ…์ธ  ๊ตฌ์„ฑ ํŒŒ์ผ์„ ์ƒ์„ฑํ•˜๊ฑฐ๋‚˜ ์—…๋ฐ์ดํŠธํ•˜์„ธ์š”.
+Starlight์˜ [`docsLoader`](/ko/reference/configuration/#docsloader) ๋ฐ [`docsSchema`](/ko/reference/configuration/#docsschema)๋ฅผ ์‚ฌ์šฉํ•˜๋Š” `docs` ์ปฌ๋ ‰์…˜์„ ์ถ”๊ฐ€ํ•˜์—ฌ ์ฝ˜ํ…์ธ  ๊ตฌ์„ฑ ํŒŒ์ผ์„ ์ƒ์„ฑํ•˜๊ฑฐ๋‚˜ ์—…๋ฐ์ดํŠธํ•˜์„ธ์š”.
```js ins={3-4,7}
// src/content.config.ts
diff --git a/docs/src/content/docs/ko/reference/configuration.mdx b/docs/src/content/docs/ko/reference/configuration.mdx
index df71387d..50ab2715 100644
--- a/docs/src/content/docs/ko/reference/configuration.mdx
+++ b/docs/src/content/docs/ko/reference/configuration.mdx
@@ -223,7 +223,11 @@ type SidebarItem =
| {
// ์ž๋™์œผ๋กœ ์ƒ์„ฑ๋œ ๋งํฌ ๊ทธ๋ฃน
label: string;
- autogenerate: { directory: string; collapsed?: boolean };
+ autogenerate: {
+ directory: string;
+ collapsed?: boolean;
+ attrs?: Record<string, string | number | boolean | undefined>;
+ };
collapsed?: boolean;
}
));
@@ -677,3 +681,117 @@ starlight({
credits: true,
});
```
+
+## ์ฝ˜ํ…์ธ  ์ปฌ๋ ‰์…˜ ๊ตฌ์„ฑ
+
+Starlight๋Š” Astro์˜ [์ฝ˜ํ…์ธ  ์ปฌ๋ ‰์…˜](https://docs.astro.build/ko/guides/content-collections/)์„ ์‚ฌ์šฉํ•˜์—ฌ ์ฝ˜ํ…์ธ ๋ฅผ ๋กœ๋“œํ•ฉ๋‹ˆ๋‹ค.
+Starlight์˜ ์ฝ˜ํ…์ธ  ๋กœ๋” ๋ฐ ์Šคํ‚ค๋งˆ๋Š” ํ•„์š”์— ๋”ฐ๋ผ ์ปฌ๋ ‰์…˜์„ ๊ตฌ์„ฑํ•˜๋Š” ๋ฐ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค.
+
+```js
+// src/content.config.ts
+import { defineCollection } from 'astro:content';
+import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders';
+import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';
+
+export const collections = {
+ docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
+ // ์„ ํƒ ์‚ฌํ•ญ: i18n ์ปฌ๋ ‰์…˜์€ ๋‹ค๊ตญ์–ด ์‚ฌ์ดํŠธ์˜ UI ๋ฒˆ์—ญ์— ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.
+ i18n: defineCollection({ loader: i18nLoader(), schema: i18nSchema() }),
+};
+```
+
+### ๋กœ๋”
+
+Starlight๋Š” ์ฝ˜ํ…์ธ  ์ปฌ๋ ‰์…˜ ๊ตฌ์„ฑ์„ ๊ฐ„์†Œํ™”ํ•˜๊ธฐ ์œ„ํ•ด `@astrojs/starlight/loaders` ๋ชจ๋“ˆ์—์„œ ๋‹ค์Œ๊ณผ ๊ฐ™์€ [Astro ๋กœ๋”](https://docs.astro.build/ko/reference/content-loader-reference/)๋ฅผ ๋‚ด๋ณด๋ƒ…๋‹ˆ๋‹ค.
+
+#### `docsLoader()`
+
+`docsLoader()`๋Š” `src/content/docs/` ๋””๋ ‰ํ„ฐ๋ฆฌ์—์„œ ๋กœ์ปฌ Markdown, MDX ๋ฐ Markdoc ํŒŒ์ผ์„ ๋กœ๋“œํ•ฉ๋‹ˆ๋‹ค.
+๋ฐ‘์ค„ (`_`)๋กœ ์‹œ์ž‘ํ•˜๋Š” ํŒŒ์ผ ์ด๋ฆ„์€ ๋ฌด์‹œ๋ฉ๋‹ˆ๋‹ค.
+
+##### ๊ฐ€์ ธ์˜ค๊ธฐ
+
+```js
+import { docsLoader } from '@astrojs/starlight/loaders';
+```
+
+##### ์˜ต์…˜
+
+###### `generateId()`
+
+**ํƒ€์ž…:** `({ entry: string; base: URL; data: Record<string, unknown> }) => string`
+
+๊ธฐ๋ณธ์ ์œผ๋กœ `docsLoader()`๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์ƒ์„ฑ๋œ ํŽ˜์ด์ง€๋Š” ํŠน์ˆ˜ ๋ฌธ์ž๋ฅผ ์ œ๊ฑฐํ•˜๊ณ  ํŒŒ์ผ ์ด๋ฆ„์„ ์†Œ๋ฌธ์ž๋กœ ์ฒ˜๋ฆฌํ•˜๋Š” sluggifier๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ํŒŒ์ผ ์ด๋ฆ„์„ ์ฒ˜๋ฆฌํ•ฉ๋‹ˆ๋‹ค. ์ด ๊ธฐ๋ณธ ๋™์ž‘์„ ์žฌ์ •์˜ํ•˜๋ ค๋ฉด ์‚ฌ์šฉ์ž ์ •์˜ `generateId()` ํ•จ์ˆ˜๋ฅผ ์ œ๊ณตํ•˜์„ธ์š”.
+
+์˜ˆ๋ฅผ ๋“ค์–ด, ์ด๋Š” ์ œ๊ฑฐ๋  ํŠน์ˆ˜ ๋ฌธ์ž๋ฅผ ๋ณด์กดํ•˜๋Š” ๋ฐ ์œ ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
+๊ธฐ๋ณธ์ ์œผ๋กœ `Example.File.md`๋Š” `/examplefile`์—์„œ ์ œ๊ณต๋ฉ๋‹ˆ๋‹ค.
+์ด๋ฅผ `/Example.File`์—์„œ ์ œ๊ณตํ•˜๋ ค๋ฉด ์‚ฌ์šฉ์ž ์ •์˜ `generateId()` ํ•จ์ˆ˜๋ฅผ ์ •์˜ํ•˜๋ฉด ๋ฉ๋‹ˆ๋‹ค.
+
+```js
+docsLoader({
+ // `.md` ๋˜๋Š” `.mdx` ํ™•์žฅ์ž๋ฅผ ์ œ๊ฑฐํ•˜๋˜, ํŒŒ์ผ ์ด๋ฆ„์€ ๊ทธ๋Œ€๋กœ ์œ ์ง€ํ•ฉ๋‹ˆ๋‹ค.
+ generateId: ({ entry }) => entry.split('.').slice(0, -1).join('.'),
+}),
+```
+
+์ž์„ธํ•œ ๋‚ด์šฉ์€ [Astro ๋ฌธ์„œ์—์„œ `generateId()`](https://docs.astro.build/ko/reference/content-loader-reference/#generateid)๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.
+
+#### `i18nLoader()`
+
+`i18nLoader()`๋Š” `src/content/i18n/` ๋””๋ ‰ํ„ฐ๋ฆฌ์—์„œ ๋กœ์ปฌ JSON ๋ฐ YAML ํŒŒ์ผ์„ ๋กœ๋“œํ•ฉ๋‹ˆ๋‹ค.
+๋ฐ‘์ค„ (`_`)๋กœ ์‹œ์ž‘ํ•˜๋Š” ํŒŒ์ผ ์ด๋ฆ„์€ ๋ฌด์‹œ๋ฉ๋‹ˆ๋‹ค.
+
+##### ๊ฐ€์ ธ์˜ค๊ธฐ
+
+```js
+import { i18nLoader } from '@astrojs/starlight/loaders';
+```
+
+##### ์˜ต์…˜
+
+ํ˜„์žฌ `i18nLoader()`๋ฅผ ๊ตฌ์„ฑํ•˜๋Š” ์˜ต์…˜์€ ์—†์Šต๋‹ˆ๋‹ค.
+
+### ์Šคํ‚ค๋งˆ
+
+Starlight๋Š” `@astrojs/starlight/schema` ๋ชจ๋“ˆ์—์„œ ๋‹ค์Œ๊ณผ ๊ฐ™์€ [์ฝ˜ํ…์ธ  ์ปฌ๋ ‰์…˜ ์Šคํ‚ค๋งˆ](https://docs.astro.build/ko/guides/content-collections/#์ปฌ๋ ‰์…˜-์Šคํ‚ค๋งˆ-์ •์˜)๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.
+์ด๋Ÿฌํ•œ ์Šคํ‚ค๋งˆ๋Š” Starlight๊ฐ€ ์˜์กดํ•˜๋Š” `docs` ๋ฐ `i18n` ์ปฌ๋ ‰์…˜์— ์‚ฌ์šฉํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.
+
+#### `docsSchema()`
+
+`docsSchema()`๋Š” `docs` ์ปฌ๋ ‰์…˜์˜ ๋ชจ๋“  ์ฝ˜ํ…์ธ ์— ๋Œ€ํ•œ ํ”„๋ŸฐํŠธ๋งคํ„ฐ๋ฅผ ๊ตฌ๋ฌธ ๋ถ„์„ํ•ฉ๋‹ˆ๋‹ค.
+
+##### ๊ฐ€์ ธ์˜ค๊ธฐ
+
+```js
+import { docsSchema } from '@astrojs/starlight/schema';
+```
+
+##### ์˜ต์…˜
+
+###### `extend`
+
+**ํƒ€์ž…:** Zod ์Šคํ‚ค๋งˆ ๋˜๋Š” Zod ์Šคํ‚ค๋งˆ๋ฅผ ๋ฐ˜ํ™˜ํ•˜๋Š” ํ•จ์ˆ˜
+**๊ธฐ๋ณธ๊ฐ’:** `z.object({})`
+
+์ถ”๊ฐ€ ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ Starlight์˜ ํ”„๋ŸฐํŠธ๋งคํ„ฐ ์Šคํ‚ค๋งˆ๋ฅผ ํ™•์žฅํ•ฉ๋‹ˆ๋‹ค.
+`extend` ์˜ต์…˜ ์‚ฌ์šฉ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ ["ํ”„๋ŸฐํŠธ๋งคํ„ฐ ์Šคํ‚ค๋งˆ ์‚ฌ์šฉ์ž ์ •์˜"](/ko/reference/frontmatter/#ํ”„๋ŸฐํŠธ๋งคํ„ฐ-์Šคํ‚ค๋งˆ-์‚ฌ์šฉ์ž-์ •์˜)๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.
+
+#### `i18nSchema()`
+
+`i18nSchema()`๋Š” `i18n` ์ปฌ๋ ‰์…˜์˜ ๋ชจ๋“  ๋ฐ์ดํ„ฐ ํŒŒ์ผ์„ ๊ตฌ๋ฌธ ๋ถ„์„ํ•ฉ๋‹ˆ๋‹ค.
+
+##### ๊ฐ€์ ธ์˜ค๊ธฐ
+
+```js
+import { i18nSchema } from '@astrojs/starlight/schema';
+```
+
+##### ์˜ต์…˜
+
+###### `extend`
+
+**ํƒ€์ž…:** Zod ๊ฐ์ฒด
+**๊ธฐ๋ณธ๊ฐ’:** `z.object({})`
+
+์ถ”๊ฐ€ ํ•„๋“œ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ Starlight์˜ i18n ์Šคํ‚ค๋งˆ๋ฅผ ํ™•์žฅํ•ฉ๋‹ˆ๋‹ค.
+`extend` ์˜ต์…˜ ์‚ฌ์šฉ์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ ["๋ฒˆ์—ญ ์Šคํ‚ค๋งˆ ํ™•์žฅํ•˜๊ธฐ"](/ko/guides/i18n/#๋ฒˆ์—ญ-์Šคํ‚ค๋งˆ-ํ™•์žฅ)๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.