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

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

@@ -28,120 +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 组件
-  ```
-
-## 参数
-
-该 Hook 接受两个参数：
-
-1. **`dictionary`**：一个声明的字典对象，包含特定键的本地化内容。
-2. **`locale`**（可选）：期望的语言环境。如果未指定，默认为当前上下文的语言环境。
-
-## 字典
-
-所有字典对象都应声明在结构化内容文件中，以确保类型安全并防止运行时错误。您可以在[此处找到设置说明](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/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",
-        "zh": "客户端组件示例"
-      }
-    },
-    "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",
-        "zh": "这是一个客户端组件示例的内容"
-      }
-    }
-  }
-}
-  "key": "component-example",
-  "content": {
-    "title": {
-      "nodeType": "translation",
-      "translation": {
-        "en": "Client Component Example",
-        "fr": "Exemple de composant client",
-        "es": "Ejemplo de componente cliente",
-        "zh": "客户端组件示例"
-      }
-    },
-    "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",
-        "zh": "这是一个客户端组件示例的内容"
-      }
-    }
-  }
-}
-```
-
 ## React 中的示例用法
 
 以下是如何在 React 组件中使用 `useDictionary` 钩子的示例：
@@ -183,18 +69,3 @@ const ServerComponentExample: FC<{ locale: string }> = ({ locale }) => {
   );
 };
 ```
-
-## 属性说明
-
-与使用可视化编辑器的集成不同，这里不适用诸如 `buttonTitle.value` 之类的属性。相反，应直接访问内容中声明的本地化字符串。
-
-```jsx
-<button title={content.title}>{content.content}</button>
-```
-
-## 额外提示
-
-- **类型安全**：始终使用 `Dictionary` 来定义字典，以确保类型安全。
-- **本地化更新**：更新内容时，确保所有语言环境保持一致，避免缺失翻译。
-
-本档案重点介绍了 `useDictionary` 钩子的集成，提供了一种简化的方式来管理本地化内容，无需依赖可视化编辑器的功能。

package/docs/zh/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/zh/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/zh/intlayer_visual_editor.md)。

package/docs/zh/packages/react-native-intlayer/exports.md

@@ -1,8 +1,8 @@
 ---
 createdAt: 2026-01-21
-updatedAt: 2026-01-21
+updatedAt: 2026-06-25
 title: react-native-intlayer 包文档
-description: 为 Intlayer 提供的 React Native 支持，包含 Provider 和 polyfill。
+description: 为 Intlayer 提供的 React Native 支持，包含 provider、hook、polyfill 和 Metro 配置。
 keywords:
   - react-native-intlayer
   - react-native
@@ -14,15 +14,20 @@ slugs:
   - react-native-intlayer
   - exports
 history:
+  - version: 9.0.0
+    date: 2026-06-25
+    changes: "重新导出完整的 react-intlayer API（hook、工具、format/html/markdown 子路径），使 React Native 应用只需依赖 react-native-intlayer"
   - version: 8.0.0
     date: 2026-01-21
-    changes: "Unified documentation for all exports"
+    changes: "统一所有导出的文档"
 author: aymericzip
 ---
 
 # react-native-intlayer 包
 
-`react-native-intlayer` 包提供将 Intlayer 集成到 React Native 应用中所需的工具。它包含一个 Provider 组件以及用于本地化支持的 polyfill。
+`react-native-intlayer` 包提供将 Intlayer 集成到 React Native 应用中所需的工具。它重新导出完整的 `react-intlayer` API（hook 和工具），并提供适用于 React Native 的 `IntlayerProvider`，以及 React Native 所需的 polyfill 和 Metro 配置。
+
+> 在 React Native 应用中，请从 `react-native-intlayer` 导入**所有内容**。您无需直接安装或导入 `react-intlayer`。
 
 ## 安装
 
@@ -34,14 +39,30 @@ npm install react-native-intlayer
 
 ### Provider 组件
 
-| 组件               | 说明                                             |
-| ------------------ | ------------------------------------------------ |
-| `IntlayerProvider` | 包裹应用并提供 Intlayer 上下文的 Provider 组件。 |
+| 组件               | 说明                                                                      |
+| ------------------ | ------------------------------------------------------------------------- |
+| `IntlayerProvider` | 包裹应用并提供 Intlayer 上下文的 Provider 组件。自动应用所需的 polyfill。 |
+
+```tsx
+import { IntlayerProvider } from "react-native-intlayer";
+```
+
+### Hook 和工具
+
+这些内容从 `react-intlayer` 重新导出，因此您可以直接从 `react-native-intlayer` 导入：
 
-导入：
+| 导出                                                                                                              | 说明                     |
+| ----------------------------------------------------------------------------------------------------------------- | ------------------------ |
+| `useIntlayer`                                                                                                     | 访问字典键的本地化内容。 |
+| `useLocale`                                                                                                       | 读取和更改当前语言环境。 |
+| `useDictionary`, `useDictionaryAsync`, `useDictionaryDynamic`, `useLoadDynamic`                                   | 以多种方式加载字典内容。 |
+| `useI18n`                                                                                                         | 兼容 i18next 的 hook。   |
+| `t`                                                                                                               | 内联翻译助手。           |
+| `getIntlayer`, `getDictionary`                                                                                    | 命令式内容获取器。       |
+| `localeCookie`, `localeInStorage`, `setLocaleCookie`, `setLocaleInStorage`, `useLocaleCookie`, `useLocaleStorage` | 语言环境持久化助手。     |
 
 ```tsx
-import "react-native-intlayer";
+import { useIntlayer, useLocale, t } from "react-native-intlayer";
 ```
 
 ### Polyfill
@@ -50,10 +71,25 @@ import "react-native-intlayer";
 | ------------------ | ---------------------------------------------------------- |
 | `intlayerPolyfill` | 为 React Native 应用启用 Intlayer 所需的 polyfill 的函数。 |
 
-导入：
+```tsx
+import { intlayerPolyfill } from "react-native-intlayer";
+```
+
+> 当您导入 `IntlayerProvider` 时，polyfill 会自动应用。仅当您需要在 provider 挂载之前使用 polyfill 时，才需要手动调用 `intlayerPolyfill`。
+
+### 格式化工具
+
+数字、日期及其他基于 Intl 的格式化 hook 可从 `/format` 子路径获取：
+
+```tsx
+import { useNumber, useDate } from "react-native-intlayer/format";
+```
+
+### Markdown 和 HTML 渲染
 
 ```tsx
-import "react-native-intlayer";
+import { MarkdownProvider } from "react-native-intlayer/markdown";
+import { HTMLProvider } from "react-native-intlayer/html";
 ```
 
 ### Metro 配置
@@ -66,8 +102,6 @@ import "react-native-intlayer";
 | `configMetroIntlayerSync` | 同步函数，合并 Metro 配置但不准备 Intlayer 资源。                    |
 | `exclusionList`           | 为 Metro 的 blockList 创建一个 RegExp 模式，以在打包时排除内容文件。 |
 
-导入：
-
 ```tsx
-import "react-native-intlayer/metro";
+import { configMetroIntlayer } from "react-native-intlayer/metro";
 ```

package/docs/zh/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.js 14 及以上版本中使用 Turbopack 作为开发服务器，并使用 `next dev --turbopack` 命令时，默认情况下字典更改不会被自动检测。
+
+这个限制发生是因为 Turbopack 无法运行 webpack 插件来并行监视内容文件中的更改。
+
+为了解决这个问题，我们使用 `--with` 选项来运行 `intlayer watch` 命令，同时运行开发服务器和 Intlayer 构建监视器。
+
+```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/zh/releases/v7.md) 了解更多信息。
+
+---
+
 ## 有用的链接
 
 - [CLI 参考](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/index.md)

package/docs/zh/releases/v7.md

@@ -25,6 +25,10 @@ author: aymericzip
 
 欢迎使用 Intlayer v7！此次重大版本发布带来了性能、类型安全和开发者体验的显著提升。以下是主要亮点，包括迁移说明和实用示例。
 
+## 目录
+
+<TOC levels={[2]} maxDepth={1} />
+
 ## 亮点
 
 - 缓存策略以加快构建速度
@@ -261,6 +265,126 @@ setLocale("en");
 
 ---
 
+## 自动代码格式化：formatCommand 配置
+
+v7 在编辑器配置中引入了 `formatCommand` 选项，允许你在 Intlayer 写入内容文件时自动格式化这些文件。这确保了内容声明文件的代码风格和格式的一致性。
+
+如果未设置，Intlayer 将尝试自动检测格式化命令。通过尝试解析以下命令：prettier、biome、eslint。
+
+### 配置
+
+`formatCommand` 选项接受一个字符串模板，其中 `{{file}}` 将被替换为实际的文件路径：
+
+```typescript fileName="intlayer.config.ts"
+export default {
+  content: {
+    formatCommand: 'bun x biome format "{{file}}" --write --log-level none',
+  },
+};
+```
+
+### 支持的格式化工具
+
+你可以使用任何接受文件路径作为参数的代码格式化工具：
+
+**使用 Biome：**
+
+```typescript
+formatCommand: 'bun x biome format "{{file}}" --write --log-level none';
+```
+
+**使用 Prettier：**
+
+```typescript
+formatCommand: 'npx prettier --write "{{file}}" --log-level silent';
+```
+
+**使用 ESLint：**
+
+```typescript
+formatCommand: 'npx eslint --fix "{{file}}" --quiet';
+```
+
+**使用 Bun 的内置格式化工具：**
+
+```typescript
+formatCommand: 'bun format "{{file}}"';
+```
+
+### 优势
+
+- **一致的格式化**：所有内容文件都根据您的项目风格指南自动格式化
+- **开发者体验**：Intlayer 写入文件后无需手动格式化
+- **团队一致性**：确保所有团队成员对内容文件应用相同的格式化
+- **CI/CD 集成**：内容文件在自动化工作流中保持一致的格式化
+
+### 工作原理
+
+当 Intlayer 写入或更新内容声明文件（`.content.ts`、`.content.js` 等）时，它会自动在该文件上运行指定的格式化命令。`{{file}}` 占位符被替换为实际的文件路径，命令在项目的基础目录中执行。
+
+---
+
+## 字典配置：更好的组织和结构
+
+v7 引入了一个新的专属 `dictionary` 配置部分，为字典相关设置和改进的内容管理提供了更好的组织。
+
+### 新的字典配置结构
+
+`fill` 属性已从 `content` 部分移到新的 `dictionary` 部分，提供了更清晰的关注点分离：
+
+**v6 配置：**
+
+```typescript fileName="intlayer.config.ts"
+export default {
+  content: {
+    autoFill: "./{{fileName}}.content.json",
+    contentDir: ["src"],
+  },
+};
+```
+
+**v7 配置：**
+
+```typescript fileName="intlayer.config.ts"
+export default {
+  content: {
+    contentDir: ["src"],
+  },
+  dictionary: {
+    fill: "./{{fileName}}.content.json",
+  },
+};
+```
+
+### 新结构的优势
+
+- **更清晰的组织**: 字典特定的设置现在被分组在一起
+- **更好的关注点分离**: 内容发现与字典操作清晰分离
+- **增强的可维护性**: 更容易理解和修改字典相关的配置
+- **未来的可扩展性**: 字典部分可以容纳额外的字典特定设置
+- **全面的字典管理**: 包括 `title`、`live`、`priority`、`tags`、`version` 和 `description` 等属性，用于创建和管理新的字典
+
+### 配置使用
+
+字典配置有两个主要目的：
+
+1. **默认值**：在创建内容声明文件时定义默认值
+2. **回退行为**：当未定义特定字段时提供回退值，允许您全局定义字典操作行为
+
+字典部分包含用于字典管理的全面属性：
+
+- **`fill`**：内容生成的自动填充行为
+- **`title`**：新字典的默认标题
+- **`live`**：用于实时更新的实时同步配置
+- **`priority`**：字典解析的优先级设置
+- **`tags`**：用于内容组织的默认标签
+- **`version`**：字典更新的版本管理
+- **`description`**：新内容的默认描述
+
+有关内容声明文件以及如何应用配置值的更多信息，请参阅[内容文件文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/content_file.md)。
+
+---
+
 ## fill 命令：更新行为以更好地管理内容
 
 v7 引入了 `fill` 命令的改进行为，提供了更可预测和灵活的内容管理：
@@ -408,6 +532,10 @@ const content = {
 - **`middleware.prefixDefault`**：被 `routing.mode` 替代
 - **`middleware.noPrefix`**：被 `routing.mode` 替代
 
+### 新配置
+
+- **`editor.formatCommand`**: 用于自动格式化内容文件的新选项
+
 ### 迁移映射
 
 #### 配置映射