@intlayer/docs 9.0.0-canary.3 → 9.0.0-canary.5

package/docs/ko/intlayer_with_react_router_v7_fs_routes.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2025-09-04
-updatedAt: 2026-05-31
+updatedAt: 2026-06-23
 title: "React Router v7 i18n - 앱을 번역하는 완전 가이드"
 description: "i18next는 이제 그만. 2026년 다국어 (i18n) React Router v7 앱 구축 가이드. AI 에이전트로 번역하고 번들 크기, SEO, 성능을 최적화하세요."
 keywords:
@@ -99,32 +99,50 @@ Intlayer는 단순한 i18n 솔루션 그 이상으로 관리에 도움이 되는
 
 ## React Router v7 애플리케이션에서 Intlayer 설정 단계별 가이드
 
-### 1단계: 의존성 설치
+<Steps>
+
+<Step number={1} title="의존성 설치">
 
 선호하는 패키지 관리자를 사용하여 필요한 패키지를 설치하세요:
 
+```bash packageManager="npm"
+npx intlayer-cli init --interactive
+```
+
+```bash packageManager="pnpm"
+pnpm dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="yarn"
+yarn dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="bun"
+bunx intlayer-cli init --interactive
+```
+
+> `--interactive` 플래그는 선택 사항입니다. AI 에이전트인 경우 `intlayer-cli init`를 사용하세요.
+
+> 이 명령은 환경을 감지하고 필요한 패키지를 설치합니다. 예를 들어:
+
 ```bash packageManager="npm"
 npm install intlayer react-intlayer
 npm install vite-intlayer --save-dev
-npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer react-intlayer
 pnpm add vite-intlayer --save-dev
-pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer react-intlayer
 yarn add vite-intlayer --save-dev
-yarn intlayer init
 ```
 
 ```bash packageManager="bun"
 bun add intlayer react-intlayer
 bun add vite-intlayer --dev
-bun x intlayer init
 ```
 
 - **intlayer**
@@ -138,7 +156,32 @@ bun x intlayer init
 - **vite-intlayer**  
   Intlayer를 [Vite 번들러](https://vite.dev/guide/why.html#why-bundle-for-production)와 통합하기 위한 Vite 플러그인과, 사용자의 선호 로케일 감지, 쿠키 관리, URL 리디렉션 처리를 위한 미들웨어를 포함합니다.
 
-### 2단계: 프로젝트 구성
+</Step>
+
+<Step number={2} title="프로젝트 구성">
+
+</Step>
+
+</Steps>
+
+#### 파일 구조
+
+```bash
+app/
+├── root.tsx                         # 로케일 경로를 위한 레이아웃 래퍼
+└──routes/
+    ├── ($locale)._index.tsx         # 홈 페이지 (/, /es, 등)
+    ├── ($locale)._index.content.ts  # 홈 페이지 콘텐츠
+    ├── ($locale).about.tsx          # About 페이지 (/about, /es/about, 등)
+    └── ($locale).about.content.ts   # About 페이지 콘텐츠
+```
+
+명명 규칙:
+
+- `($locale)` - 로케일 파라미터를 위한 선택적 동적 세그먼트
+- `_layout` - 자식 경로를 래핑하는 레이아웃 경로
+- `_index` - 인덱스 경로 (부모 경로에서 렌더링)
+- `.` (점) - 경로 세그먼트 구분 (예: `($locale).about` → `/:locale?/about`)
 
 ## 파일 시스템 기반 라우트를 사용한 React Router v7 애플리케이션에서 Intlayer 설정을 위한 단계별 가이드
 
@@ -191,7 +234,9 @@ export default config;
 
 > 이 구성 파일을 통해 지역화된 URL, 미들웨어 리디렉션, 쿠키 이름, 콘텐츠 선언의 위치 및 확장자 설정, 콘솔에서 Intlayer 로그 비활성화 등 다양한 설정을 할 수 있습니다. 사용 가능한 모든 매개변수 목록은 [구성 문서](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/configuration.md)를 참조하세요.
 
-### 3단계: Vite 구성에 Intlayer 통합하기
+<Steps>
+
+<Step number={3} title="Vite 구성에 Intlayer 통합하기">
 
 구성에 intlayer 플러그인을 추가하세요:
 
@@ -207,6 +252,10 @@ export default defineConfig({
 
 > `intlayer()` Vite 플러그인은 Intlayer를 Vite와 통합하는 데 사용됩니다. 이 플러그인은 콘텐츠 선언 파일의 빌드를 보장하고 개발 모드에서 이를 모니터링합니다. 또한 Vite 애플리케이션 내에서 Intlayer 환경 변수를 정의하며, 성능 최적화를 위한 별칭(alias)도 제공합니다.
 
+</Step>
+
+</Steps>
+
 <Steps>
 
 <Step number={4} title="React Router v7 라우트 구성">
@@ -326,9 +375,7 @@ bun run build # Or bun run dev
 
 </Step>
 
-</Steps>
-
-### 5단계: 레이아웃 컴포넌트 생성
+<Step number={5} title="레이아웃 컴포넌트 생성">
 
 루트 레이아웃과 로케일별 레이아웃을 설정하세요:
 
@@ -351,7 +398,9 @@ export default function RootLayout({ params }: Route.ComponentProps) {
 }
 ```
 
-### 6단계: 콘텐츠 선언하기
+</Step>
+
+<Step number={6} title="콘텐츠 선언하기">
 
 번역을 저장하기 위해 콘텐츠 선언을 생성하고 관리하세요:
 
@@ -391,7 +440,9 @@ export default pageContent;
 
 > 자세한 내용은 [콘텐츠 선언 문서](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/dictionary/content_file.md)를 참조하세요.
 
-### 7단계: 로케일 인식 컴포넌트 생성
+</Step>
+
+<Step number={7} title="로케일 인식 컴포넌트 생성">
 
 로케일 인식 내비게이션을 위한 `LocalizedLink` 컴포넌트를 생성합니다:
 
@@ -453,7 +504,9 @@ export const useLocalizedNavigate = () => {
 };
 ```
 
-### 8단계: 페이지에서 Intlayer 활용하기
+</Step>
+
+<Step number={8} title="페이지에서 Intlayer 활용하기">
 
 애플리케이션 전반에서 콘텐츠 사전을 액세스하세요:
 
@@ -480,7 +533,9 @@ export default function Page() {
 
 > `useIntlayer` 훅에 대해 더 알아보려면 [문서](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/packages/react-intlayer/useIntlayer.md)를 참조하세요.
 
-### 9단계: 로케일 스위처 컴포넌트 만들기
+</Step>
+
+<Step number={9} title="로케일 스위처 컴포넌트 만들기">
 
 사용자가 언어를 변경할 수 있도록 컴포넌트를 만드세요:
 
@@ -541,7 +596,9 @@ export const LocaleSwitcher: FC = () => {
 
 > `useLocale` 훅에 대해 더 알아보려면 [문서](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/packages/react-intlayer/useLocale.md)를 참조하세요.
 
-### 10단계: HTML 속성 관리 추가 (선택 사항)
+</Step>
+
+<Step number={10} title="HTML 속성 관리 추가 (선택 사항)" isOptional={true}>
 
 HTML의 lang 및 dir 속성을 관리하는 훅을 만듭니다:
 
@@ -579,6 +636,10 @@ export default function RootLayout() {
 }
 ```
 
+</Step>
+
+</Steps>
+
 ## Configure TypeScript
 
 Intlayer uses module augmentation to get benefits of TypeScript and make your codebase stronger.
@@ -633,95 +694,6 @@ To go further, you can implement the [visual editor](https://github.com/aymericz
 
 ---
 
-## Documentation References
-
-- [Intlayer Documentation](https://intlayer.org)
-- [React Router v7 Documentation](https://reactrouter.com/)
-- [React Router fs-routes Documentation](https://reactrouter.com/how-to/file-route-conventions)
-- [useIntlayer hook](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useIntlayer.md)
-- [useLocale hook](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/react-intlayer/useLocale.md)
-- [Content Declaration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/content_file.md)
-- [Configuration](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md)
-
-This comprehensive guide provides everything you need to integrate Intlayer with React Router v7 using file-system based routing for a fully internationalized application with locale-aware routing and TypeScript support.
-
-### 11단계: 미들웨어 추가 (선택 사항)
-
-`intlayerProxy`를 사용하여 애플리케이션에 서버 사이드 라우팅을 추가할 수도 있습니다. 이 플러그인은 URL을 기반으로 현재 로케일을 자동으로 감지하고 적절한 로케일 쿠키를 설정합니다. 로케일이 지정되지 않은 경우, 플러그인은 사용자의 브라우저 언어 설정을 기반으로 가장 적합한 로케일을 결정합니다. 로케일이 감지되지 않으면 기본 로케일로 리디렉션합니다.
-
-> `intlayerProxy`를 프로덕션 환경에서 사용하려면 `vite-intlayer` 패키지를 `devDependencies`에서 `dependencies`로 변경해야 합니다.
-
-```typescript {3,7} fileName="vite.config.ts"
-import { reactRouter } from "@react-router/dev/vite";
-import { defineConfig } from "vite";
-import { intlayer, intlayerProxy } from "vite-intlayer";
-
-export default defineConfig({
-  plugins: [
-    intlayerProxy(), // should be placed first
-    reactRouter(),
-
-    intlayer(),
-  ],
-});
-```
-
----
-
-## TypeScript 구성
-
-Intlayer는 모듈 확장을 사용하여 TypeScript의 이점을 활용하고 코드베이스를 더욱 견고하게 만듭니다.
-
-TypeScript 구성에 자동 생성된 타입이 포함되어 있는지 확인하세요:
-
-```json5 fileName="tsconfig.json"
-{
-  // ... 기존 구성
-  include: [
-    // ... 기존 포함 항목
-    ".intlayer/**/*.ts", // 자동 생성된 타입 포함
-  ],
-}
-```
-
----
-
-## Git 구성
-
-Intlayer가 생성한 파일은 Git 저장소에 커밋하지 않도록 무시하는 것이 좋습니다.
-
-이를 위해 `.gitignore` 파일에 다음 지침을 추가할 수 있습니다:
-
-```plaintext fileName=".gitignore"
-# Intlayer가 생성한 파일 무시
-.intlayer
-```
-
----
-
-## VS 코드 확장
-
-Intlayer 개발 경험을 향상시키기 위해 공식 **Intlayer VS 코드 확장**을 설치할 수 있습니다.
-
-[VS 코드 마켓플레이스에서 설치하기](https://marketplace.visualstudio.com/items?itemName=intlayer.intlayer-vs-code-extension)
-
-이 확장은 다음 기능을 제공합니다:
-
-- 번역 키에 대한 **자동 완성**.
-- 누락된 번역에 대한 **실시간 오류 감지**.
-- 번역된 콘텐츠의 **인라인 미리보기**.
-- 번역을 쉽게 생성하고 업데이트할 수 있는 **빠른 작업**.
-
-확장 사용 방법에 대한 자세한 내용은 [Intlayer VS 코드 확장 문서](https://intlayer.org/doc/vs-code-extension)를 참조하세요.
-
----
-
-## 더 나아가기
-
-더 나아가려면 [비주얼 에디터](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/intlayer_visual_editor.md)를 구현하거나 [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/intlayer_CMS.md)를 사용하여 콘텐츠를 외부화할 수 있습니다.
-
----
-
 ## 문서 참조
 
 - [Intlayer 문서](https://intlayer.org)

package/docs/ko/intlayer_with_storybook.md

@@ -98,7 +98,9 @@ Storybook은 UI 컴포넌트를 독립적으로 개발하고 문서화하기 위
 <Tabs>
 <Tab value="Vite Setup">
 
-### 1단계: 종속성 설치
+<Steps>
+
+<Step number={1} title="종속성 설치">
 
 ```bash packageManager="npm"
 npm install intlayer react-intlayer
@@ -128,7 +130,9 @@ bun add vite-intlayer --dev
 
 ---
 
-### 2단계: Intlayer 구성 생성
+</Step>
+
+<Step number={2} title="Intlayer 구성 생성">
 
 프로젝트 루트(또는 디자인 시스템 패키지 내부)에 `intlayer.config.ts`를 생성합니다:
 
@@ -157,7 +161,9 @@ export default config;
 
 ---
 
-### 3단계: Storybook에 Vite 플러그인 추가
+</Step>
+
+<Step number={3} title="Storybook에 Vite 플러그인 추가">
 
 Storybook의 `viteFinal` 훅을 사용하면 내부 Vite 구성을 확장할 수 있습니다. 여기에 `intlayer()` 플러그인을 가져와서 추가합니다:
 
@@ -198,7 +204,9 @@ export default config;
 
 ---
 
-### 4단계: `IntlayerProvider` 데코레이터 및 로케일 도구 모음 추가
+</Step>
+
+<Step number={4} title="`IntlayerProvider` 데코레이터 및 로케일 도구 모음 추가">
 
 Storybook의 `preview` 파일은 모든 스토리를 `IntlayerProvider`로 감싸고 도구 모음에 로케일 스위처를 노출하기에 적합한 장소입니다:
 
@@ -255,7 +263,9 @@ export default preview;
 </Tab>
 <Tab value="Webpack Setup">
 
-### 1단계: 종속성 설치
+</Step>
+
+<Step number={1} title="종속성 설치">
 
 ```bash packageManager="npm"
 npm install intlayer react-intlayer
@@ -279,7 +289,9 @@ bun add @intlayer/webpack --dev
 
 ---
 
-### 2단계: Intlayer 구성 생성
+</Step>
+
+<Step number={2} title="Intlayer 구성 생성">
 
 프로젝트 루트에 `intlayer.config.ts`를 생성합니다:
 
@@ -301,7 +313,9 @@ export default config;
 
 ---
 
-### 3단계: Storybook의 Webpack 구성
+</Step>
+
+<Step number={3} title="Storybook의 Webpack 구성">
 
 Webpack 기반 Storybook 설정(예: `@storybook/react-webpack5`)의 경우, `webpackFinal`을 통해 webpack 구성을 확장하여 Intlayer 별칭(alias) 및 로더를 추가합니다:
 
@@ -328,7 +342,9 @@ export default config;
 
 ---
 
-### 4단계: `IntlayerProvider` 데코레이터 및 로케일 도구 모음 추가
+</Step>
+
+<Step number={4} title="`IntlayerProvider` 데코레이터 및 로케일 도구 모음 추가">
 
 Vite 설정과 동일하게 `.storybook/preview.tsx`에 데코레이터와 전역 로케일 유형을 추가합니다:
 
@@ -374,6 +390,10 @@ export default preview;
 
 ---
 
+</Step>
+
+</Steps>
+
 ## 콘텐츠 선언
 
 각 컴포넌트 옆에 `*.content.ts` 파일을 생성합니다. Intlayer는 컴파일 중에 이를 자동으로 감지합니다.