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

package/docs/ko/packages/intlayer/getLocalizedUrl.md

@@ -36,6 +36,36 @@ author: aymericzip
 
 ---
 
+## 함수 서명
+
+```typescript
+getLocalizedUrl(
+  url: string,                   // 필수
+  currentLocale: Locales,        // 필수
+  options?: {                    // 선택사항
+    locales?: Locales[];
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): string
+```
+
+---
+
+## 매개변수
+
+### 필수 파라미터
+
+- `url: string`
+  - **Description**: 로케일을 접두사로 추가할 원본 URL 문자열입니다.
+  - **Type**: `string`
+  - **Required**: Yes
+
+- `currentLocale: Locales`
+  - **Description**: URL이 로컬라이제이션되는 현재 로케일입니다.
+  - **Type**: `Locales`
+  - **Required**: Yes
+
 ## 매개변수
 
 - `url: string`
@@ -70,6 +100,25 @@ author: aymericzip
 
 ## 사용 예시
 
+### 기본 사용법 (필수 매개변수만 사용)
+
+국제화 설정으로 프로젝트를 구성한 후에는 필수 매개변수만으로 함수를 사용할 수 있습니다:
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// 프로젝트의 locales, defaultLocale 및 mode 구성을 사용합니다
+getLocalizedUrl("/about", Locales.FRENCH);
+// 출력: "/fr/about" (French가 지원되고 mode가 'prefix-no-default'라고 가정)
+
+getLocalizedUrl("/about", Locales.ENGLISH);
+// 출력: "/about" 또는 "/en/about" (mode 설정에 따라 다름)
+```
+
+### 고급 사용법 (선택적 매개변수 포함)
+
+선택적 `options` 매개변수를 제공하여 기본 구성을 재정의할 수 있습니다:
+
 ### 상대 URL
 
 ```typescript codeFormat={["typescript", "esm"]}
@@ -117,6 +166,30 @@ getLocalizedUrl(
 // 출력: 기본(영어) 로케일의 경우 "/about"
 ```
 
+### 부분 Configuration Override
+
+선택적 매개변수 중 일부만 제공할 수도 있습니다. 함수는 지정하지 않은 매개변수에 대해 프로젝트 configuration을 사용합니다:
+
+```typescript codeFormat="typescript"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// locales만 override, defaultLocale과 mode는 프로젝트 config 사용
+getLocalizedUrl("/about", Locales.SPANISH, {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+});
+
+// mode만 override, locales과 defaultLocale은 프로젝트 config 사용
+getLocalizedUrl("/about", Locales.ENGLISH, {
+  mode: "prefix-all", // 기본 locale을 포함한 모든 locale에 prefix 강제
+});
+
+// 여러 옵션 override
+getLocalizedUrl("/about", Locales.FRENCH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "search-params", // 쿼리 매개변수 사용: /about?locale=fr
+});
+```
+
 ### 절대 URL
 
 ```typescript

package/docs/ko/packages/intlayer/getMultilingualUrls.md

@@ -33,6 +33,23 @@ author: aymericzip
 
 ---
 
+## 함수 서명
+
+```typescript
+getMultilingualUrls(
+  url: string,                   // 필수
+  options?: {                    // 선택사항
+    locales?: Locales[];
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): StrictModeLocaleMap<string>
+```
+
+---
+
+## 매개변수
+
 ## 매개변수
 
 - `url: string`
@@ -54,6 +71,33 @@ author: aymericzip
   - **타입**: `boolean`
   - **기본값**: `prefixDefaultDefault`
 
+### 선택적 매개변수
+
+- `options?: object`
+  - **Description**: URL 지역화 동작을 위한 구성 객체입니다.
+  - **Type**: `object`
+  - **Required**: No (선택사항)
+
+  - `options.locales?: Locales[]`
+    - **Description**: 지원되는 로케일의 배열입니다. 제공되지 않으면 프로젝트 구성에서 구성된 로케일을 사용합니다.
+    - **Type**: `Locales[]`
+    - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/configuration.md#middleware)
+
+  - `options.defaultLocale?: Locales`
+    - **Description**: 애플리케이션의 기본 로케일입니다. 제공되지 않으면 프로젝트 구성에서 구성된 기본 로케일을 사용합니다.
+    - **Type**: `Locales`
+    - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/configuration.md#middleware)
+
+  - `options.mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Description**: 로케일 처리를 위한 URL 라우팅 모드입니다. 제공되지 않으면 프로젝트 구성에서 구성된 모드를 사용합니다.
+    - **Type**: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Default**: [`Project Configuration`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/configuration.md#middleware)
+    - **Modes**:
+      - `prefix-no-default`: 기본 로케일의 경우 접두사 없음, 다른 로케일의 경우 접두사 포함
+      - `prefix-all`: 기본 로케일을 포함한 모든 로케일에 접두사 포함
+      - `no-prefix`: URL에 로케일 접두사 없음
+      - `search-params`: 로케일에 쿼리 매개변수 사용 (예: `?locale=fr`)
+
 ### 반환값
 
 - **타입**: `IConfigLocales<string>`
@@ -63,6 +107,20 @@ author: aymericzip
 
 ## 사용 예시
 
+### 기본 사용법 (프로젝트 구성 사용)
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { getMultilingualUrls, Locales } from "intlayer";
+
+// 프로젝트의 구성에서 locales, defaultLocale, mode를 사용합니다
+getMultilingualUrls("/dashboard");
+// 출력 (프로젝트 구성에 en, fr이 있고 mode가 'prefix-no-default'인 경우):
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
 ### 상대 URL
 
 ```typescript codeFormat={["typescript", "esm", "commonjs"]}
@@ -97,6 +155,60 @@ getMultilingualUrls(
 
 ---
 
+### 다양한 라우팅 모드
+
+```typescript
+// prefix-no-default: 기본 로케일에 대한 접두사 없음
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// 출력: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+// prefix-all: 모든 로케일에 접두사 추가
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// 출력: {
+//   en: "/en/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+// no-prefix: URL에 로케일 접두사 없음
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "no-prefix",
+});
+// 출력: {
+//   en: "/dashboard",
+//   fr: "/dashboard",
+//   es: "/dashboard"
+// }
+
+// search-params: 쿼리 매개변수로 로케일 전달
+getMultilingualUrls("/dashboard", {
+  locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  defaultLocale: Locales.ENGLISH,
+  mode: "search-params",
+});
+// 출력: {
+//   en: "/dashboard?locale=en",
+//   fr: "/dashboard?locale=fr",
+//   es: "/dashboard?locale=es"
+// }
+```
+
+---
+
 ## 예외 상황
 
 - **로케일 세그먼트 없음:**

package/docs/ko/packages/next-intlayer/t.md

@@ -133,6 +133,40 @@ export const ServerComponentExample: FC = () => (
 
 ---
 
+### 속성의 인라인 번역
+
+`t` 함수는 JSX 속성의 인라인 번역에 특히 유용합니다.
+`alt`, `title`, `href`, 또는 `aria-label`과 같은 속성을 현지화할 때, 속성 내에서 직접 `t`를 사용할 수 있습니다.
+
+```jsx
+<button
+  aria-label={t({
+    ko: "제출",
+    en: "Submit",
+    fr: "Soumettre",
+    es: "Enviar",
+  })}
+>
+  {t({
+    ko: "제출",
+    en: "Submit",
+    fr: "Soumettre",
+    es: "Enviar",
+  })}
+  <img
+    src="/path/to/image"
+    alt={t({
+      ko: "아름다운 풍경",
+      en: "A beautiful scenery",
+      fr: "Un beau paysage",
+      es: "Un hermoso paisaje",
+    })}
+  />
+</button>
+```
+
+---
+
 ## 고급 주제
 
 ### TypeScript 통합

package/docs/ko/packages/next-intlayer/useLocale.md

@@ -112,9 +112,4 @@ const LocaleSwitcher: FC = () => {
 
 ## 결론
 
-- **`setLocale`**: 애플리케이션의 로케일을 변경하고 URL을 이에 맞게 업데이트하는 함수입니다. 구성에 따라 경로에 로케일을 추가할지 여부와 접두사 규칙을 처리합니다. `next/navigation`의 `useRouter`를 사용하여 `push` 및 `refresh`와 같은 내비게이션 기능을 활용합니다.
-- **`pathWithoutLocale`**: 로케일이 제거된 경로를 반환하는 계산된 속성입니다. URL 비교에 유용합니다. 예를 들어 현재 로케일이 `fr`이고 URL이 `fr/my_path`인 경우, 로케일이 제거된 경로는 `/my_path`가 됩니다. `next/navigation`의 `usePathname`을 사용하여 현재 경로를 가져옵니다.
-
-## 결론
-
 `next-intlayer`의 `useLocale` 훅은 Next.js 애플리케이션에서 로케일을 관리하는 데 중요한 도구입니다. 로케일 저장, 상태 관리, URL 수정 등을 원활하게 처리하여 다중 로케일에 맞게 애플리케이션을 통합적으로 적응시킬 수 있는 접근 방식을 제공합니다.

package/docs/ko/packages/react-intlayer/t.md

@@ -161,26 +161,6 @@ const App: FC<{ locale: Locales }> = ({ locale }) => (
   - `IntlayerProvider`가 적절한 `locale`로 올바르게 설정되었는지 확인하세요.
   - 번역 객체에 필요한 모든 로케일이 포함되어 있는지 확인하세요.
 
-### TypeScript에서 번역 누락
-
-- **원인**: 번역 객체가 필요한 로케일을 모두 만족하지 않아 TypeScript 오류가 발생합니다.
-- **해결 방법**: `IConfigLocales` 타입을 사용하여 번역의 완전성을 강제하세요.
-
-```typescript codeFormat={["typescript", "esm", "commonjs"]}
-const translations: IConfigLocales<string> = {
-  en: "Text",
-  fr: "Texte",
-  // es: 'Texto', // 'es'가 누락되면 TypeScript 오류가 발생합니다
-};
-
-const text = t(translations);
-```
-
-- **원인**: 현재 로케일이 제대로 설정되지 않았거나, 현재 로케일에 대한 번역이 누락된 경우입니다.
-- **해결책**:
-  - `IntlayerProvider`가 적절한 `locale`과 함께 올바르게 설정되었는지 확인하세요.
-  - 번역 객체에 필요한 모든 로케일이 포함되어 있는지 확인하세요.
-
 ### TypeScript에서 번역 누락 문제
 
 - **원인**: 번역 객체가 요구되는 모든 로케일을 충족하지 않아 TypeScript 오류가 발생합니다.

package/docs/ko/packages/react-intlayer/useDictionary.md

@@ -28,98 +28,6 @@ author: aymericzip
 
 이 섹션에서는 시각적 편집기 없이 지역화된 콘텐츠를 효율적으로 처리할 수 있도록 React 애플리케이션 내에서 `useDictionary` 훅을 사용하는 방법에 대해 자세히 안내합니다.
 
-## React에서 `useDictionary` 가져오기
-
-`useDictionary` 훅은 상황에 따라 다음과 같이 React 애플리케이션에 통합할 수 있습니다:
-
-- **클라이언트 컴포넌트:**
-
-  ```typescript codeFormat="typescript"
-  import { useDictionary } from "react-intlayer"; // 클라이언트 측 React 컴포넌트에서 사용
-  ```
-
-  ```javascript codeFormat="esm"
-  import { useDictionary } from "react-intlayer"; // 클라이언트 측 React 컴포넌트에서 사용
-  ```
-
-  ```javascript codeFormat="commonjs"
-  const { useDictionary } = require("react-intlayer"); // 클라이언트 측 React 컴포넌트에서 사용
-  ```
-
-- **서버 컴포넌트:**
-
-  ```typescript codeFormat="typescript"
-  import { useDictionary } from "react-intlayer/server"; // 서버 측 React 컴포넌트에서 사용
-  ```
-
-  ```javascript codeFormat="esm"
-  import { useDictionary } from "react-intlayer/server"; // 서버 측 React 컴포넌트에서 사용
-  ```
-
-  ```javascript codeFormat="commonjs"
-  const { useDictionary } = require("react-intlayer/server"); // 서버 측 React 컴포넌트에서 사용
-  ```
-
-## 매개변수
-
-이 훅은 두 개의 매개변수를 받습니다:
-
-1. **`dictionary`**: 특정 키에 대한 현지화된 콘텐츠를 포함하는 선언된 사전 객체입니다.
-2. **`locale`** (선택 사항): 원하는 로케일입니다. 지정하지 않으면 현재 컨텍스트의 로케일이 기본값으로 사용됩니다.
-
-## 사전
-
-모든 사전 객체는 타입 안전성을 보장하고 런타임 오류를 방지하기 위해 구조화된 콘텐츠 파일에 선언되어야 합니다. [설정 지침은 여기](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/dictionary/content_file.md)에서 확인할 수 있습니다. 다음은 콘텐츠 선언 예시입니다:
-
-```typescript fileName="./component.content.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-import { t, type Dictionary } from "intlayer";
-
-const componentContent = {
-  key: "component-example",
-  content: {
-    title: t({
-      en: "Client Component Example",
-      fr: "Exemple de composant client",
-      es: "Ejemplo de componente cliente",
-    }),
-    content: t({
-      en: "This is the content of a client component example",
-      fr: "Ceci est le contenu d'un exemple de composant client",
-      es: "Este es el contenido de un ejemplo de componente cliente",
-    }),
-  },
-} satisfies Dictionary;
-
-export default componentContent;
-```
-
-```json fileName="./component.content.json" contentDeclarationFormat="json"
-{
-  "$schema": "https://intlayer.org/schema.json",
-  "key": "component-example",
-  "content": {
-    "title": {
-      "nodeType": "translation",
-      "translation": {
-        "en": "Client Component Example",
-        "fr": "Exemple de composant client",
-        "es": "Ejemplo de componente cliente",
-        "ko": "클라이언트 컴포넌트 예제"
-      }
-    },
-    "content": {
-      "nodeType": "translation",
-      "translation": {
-        "en": "This is the content of a client component example",
-        "fr": "Ceci est le contenu d'un exemple de composant client",
-        "es": "Este es el contenido de un ejemplo de componente cliente",
-        "ko": "이것은 클라이언트 컴포넌트 예제의 내용입니다"
-      }
-    }
-  }
-}
-```
-
 ## React에서의 사용 예제
 
 아래는 React 컴포넌트에서 `useDictionary` 훅을 사용하는 예제입니다:
@@ -141,35 +49,6 @@ const ComponentExample: FC = () => {
 };
 ```
 
-## 서버 통합
-
-`IntlayerProvider` 외부에서 `useDictionary` 훅을 사용하는 경우, 컴포넌트를 렌더링할 때 로케일을 명시적으로 파라미터로 제공해야 합니다:
-
-```tsx fileName="./ServerComponentExample.tsx" codeFormat={["typescript", "esm"]}
-import type { FC } from "react";
-import { useDictionary } from "react-intlayer/server";
-import clientComponentExampleContent from "./component.content";
-
-const ServerComponentExample: FC<{ locale: string }> = ({ locale }) => {
-  const { content } = useDictionary(clientComponentExampleContent, locale);
-
-  return (
-    <div>
-      <h1>{content.title}</h1>
-      <p>{content.content}</p>
-    </div>
-  );
-};
-```
-
-## 속성에 대한 참고 사항
-
-비주얼 에디터를 사용하는 통합과 달리, `buttonTitle.value`와 같은 속성은 여기서 적용되지 않습니다. 대신, 콘텐츠에 선언된 대로 로컬라이즈된 문자열에 직접 접근하세요.
-
-```jsx
-<button title={content.title}>{content.content}</button>
-```
-
 ## 추가 팁
 
 - **타입 안전성**: 항상 `Dictionary`를 사용하여 사전을 정의하여 타입 안전성을 보장하세요.

package/docs/ko/packages/react-intlayer/useIntlayer.md

@@ -29,49 +29,6 @@ author: aymericzip
 
 이 섹션에서는 React 애플리케이션 내에서 `useIntlayer` 훅을 사용하는 방법에 대해 자세히 안내하며, 효율적인 콘텐츠 현지화를 가능하게 합니다.
 
-## React에서 `useIntlayer` 가져오기
-
-`useIntlayer` 훅은 컨텍스트에 따라 React 애플리케이션에 다음과 같이 가져와서 통합할 수 있습니다:
-
-- **클라이언트 컴포넌트:**
-
-  ```typescript codeFormat="typescript"
-  import { useIntlayer } from "react-intlayer"; // 클라이언트 측 React 컴포넌트에서 사용
-  ```
-
-  ```javascript codeFormat="esm"
-  import { useIntlayer } from "react-intlayer"; // 클라이언트 측 React 컴포넌트에서 사용
-  ```
-
-  ```javascript codeFormat="commonjs"
-  const { useIntlayer } = require("react-intlayer"); // 클라이언트 측 React 컴포넌트에서 사용
-  ```
-
-- **서버 컴포넌트:**
-
-  ```typescript codeFormat="commonjs"
-  import { useIntlayer } from "react-intlayer/server"; // 서버 측 React 컴포넌트에서 사용
-  ```
-
-  ```javascript codeFormat="esm"
-  import { useIntlayer } from "react-intlayer/server"; // 서버 측 React 컴포넌트에서 사용
-  ```
-
-  ```javascript codeFormat="commonjs"
-  const { useIntlayer } = require("react-intlayer/server"); // 서버 측 React 컴포넌트에서 사용
-  ```
-
-## 매개변수
-
-이 훅은 두 개의 매개변수를 받습니다:
-
-1. **`key`**: 지역화된 콘텐츠를 가져오기 위한 사전 키입니다.
-2. **`locale`** (선택 사항): 원하는 로케일입니다. 지정하지 않으면 컨텍스트의 로케일이 기본값으로 사용됩니다.
-
-## 사전
-
-모든 사전 키는 타입 안전성을 높이고 오류를 방지하기 위해 콘텐츠 선언 파일 내에 선언되어야 합니다. [설정 지침은 여기에서 확인할 수 있습니다](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/dictionary/content_file.md).
-
 ## React에서 사용 예제
 
 React 컴포넌트 내에서 `useIntlayer` 훅을 사용하는 예제:
@@ -131,14 +88,6 @@ const ServerComponentExample = () => {
 };
 ```
 
-## 속성 처리
-
-속성을 현지화할 때는 콘텐츠 값을 적절히 접근하세요:
-
-```jsx
-<button title={content.buttonTitle.value}>{content.buttonText}</button>
-```
-
 ## 추가 자료
 
 - **Intlayer 비주얼 에디터**: 보다 직관적인 콘텐츠 관리 경험을 위해 비주얼 에디터 문서를 [여기](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/intlayer_visual_editor.md)에서 참고하세요.

package/docs/ko/releases/v6.md

@@ -25,6 +25,10 @@ author: aymericzip
 
 Intlayer v6에 오신 것을 환영합니다! 이번 릴리스는 성능, 개발자 경험, 그리고 안정성에 중점을 두고 있습니다. 아래는 주요 내용과 마이그레이션 노트, 복사하여 붙여넣을 수 있는 예제들입니다.
 
+## 목차
+
+<TOC levels={[2]} maxDepth={1} />
+
 ## 주요 내용
 
 - 누락된 번역을 감지하는 새로운 명령어: `npx intlayer content test`
@@ -294,6 +298,24 @@ bun x intlayer live --with 'vite preview'
 
 ---
 
+## Turbopack에서 파일을 감시하기 위한 병렬 프로세스
+
+`next dev --turbopack` 명령으로 Next.js 14 이상에서 Turbopack을 개발 서버로 사용할 때, 기본적으로 사전 변경 사항이 자동으로 감지되지 않습니다.
+
+이러한 제한은 Turbopack이 콘텐츠 파일의 변경 사항을 모니터링하기 위해 웹팩 플러그인을 병렬로 실행할 수 없기 때문입니다.
+
+이를 해결하기 위해 개발 서버와 Intlayer 빌드 감시기를 동시에 실행하기 위해 `--with` 옵션을 사용하여 `intlayer watch` 명령을 제공합니다.
+
+```json5 fileName="package.json"
+{
+  "scripts": {
+    "dev": "npx intlayer watch --with 'next dev --turbopack'",
+  },
+}
+```
+
+---
+
 ## 마이그레이션 노트
 
 - 제거됨: `dictionaryOutput` (이전에는 `i18next` 또는 `next-intl`). 향후 버전에서 플러그형 어댑터로 다시 제공될 예정입니다. 구성에서 해당 필드를 제거하세요.
@@ -312,6 +334,12 @@ bun x intlayer live --with 'vite preview'
 
 ---
 
+## v6에서 v7로의 마이그레이션 노트
+
+자세한 내용은 [v6에서 v7로의 마이그레이션 노트](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/releases/v7.md)를 확인하세요.
+
+---
+
 ## 유용한 링크
 
 - [CLI 참조](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/cli/index.md)