@intlayer/docs 8.6.0 → 8.6.10

package/docs/zh/intlayer_with_vanilla.md

@@ -0,0 +1,506 @@
+---
+createdAt: 2026-03-31
+updatedAt: 2026-03-31
+title: Vanilla JS i18n - 2026 年如何翻译 Vanilla JS 应用
+description: 了解如何让您的 Vanilla JS 网站支持多语言。按照文档进行国际化 (i18n) 和翻译。
+keywords:
+  - 国际化
+  - 文档
+  - Intlayer
+  - Vanilla JS
+  - JavaScript
+  - TypeScript
+  - HTML
+slugs:
+  - doc
+  - environment
+  - vanilla
+applicationTemplate: https://github.com/aymericzip/intlayer-vanilla-template
+history:
+  - version: 8.4.10
+    date: 2026-03-31
+    changes: "初始化历史记录"
+---
+
+# 使用 Intlayer 翻译您的 Vanilla JS 网站 | 国际化 (i18n)
+
+## 目录
+
+<TOC/>
+
+## 什么是 Intlayer？
+
+**Intlayer** 是一个创新的开源国际化 (i18n) 库，旨在简化现代 Web 应用中的多语言支持。
+
+借助 Intlayer，您可以：
+
+- **轻松管理翻译**：在组件级使用声明式字典。
+- **动态本地化元数据、路由和内容**。
+- **确保 TypeScript 支持**：通过自动生成的类型，提升自动补全和错误检测能力。
+- **受益于高级功能**：例如动态语言检测和切换。
+
+本指南演示了如何在**不使用包管理器或构建工具**（如 Vite、Webpack 等）的情况下，在 Vanilla JavaScript 应用中使用 Intlayer。
+
+如果您的应用使用了构建工具（如 Vite），我们建议参考 [Vite + Vanilla JS 指南](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_with_vite+vanilla.md)。
+
+使用独立版本 (standalone bundle)，您可以通过单个 JavaScript 文件直接在 HTML 文件中导入 Intlayer，非常适合旧项目或简单的静态网站。
+
+---
+
+## 在 Vanilla JS 应用中设置 Intlayer 的步骤指南
+
+### 第一步：安装依赖
+
+使用 npm 安装必要的包：
+
+```bash packageManager="npm"
+# 生成 intlayer 和 vanilla-intlayer 的独立 bundle
+# 此文件将导入到您的 HTML 文件中
+npx intlayer standalone --packages intlayer vanilla-intlayer --outfile intlayer.js
+
+# 使用配置文件初始化 intlayer
+npx intlayer init --no-gitignore
+
+# 构建字典
+npx intlayer build
+```
+
+```bash packageManager="pnpm"
+# 生成 intlayer 和 vanilla-intlayer 的独立 bundle
+# 此文件将导入到您的 HTML 文件中
+pnpm intlayer standalone --packages intlayer vanilla-intlayer --outfile intlayer.js
+
+# 使用配置文件初始化 intlayer
+pnpm intlayer init --no-gitignore
+
+# 构建字典
+pnpm intlayer build
+```
+
+```bash packageManager="yarn"
+# 生成 intlayer 和 vanilla-intlayer 的独立 bundle
+# 此文件将导入到您的 HTML 文件中
+yarn intlayer standalone --packages intlayer vanilla-intlayer --outfile intlayer.js
+
+# 初始化 intlayer 配置文件、TypeScript（如果已设置）、环境变量
+yarn intlayer init --no-gitignore
+
+# 构建字典
+yarn intlayer build
+```
+
+```bash packageManager="bun"
+# 生成 intlayer 和 vanilla-intlayer 的独立 bundle
+# 此文件将导入到您的 HTML 文件中
+bun x intlayer standalone --packages intlayer vanilla-intlayer --outfile intlayer.js
+
+# 使用配置文件初始化 intlayer
+bun x intlayer init --no-gitignore
+
+# 构建字典
+bun x intlayer build
+```
+
+- **intlayer**
+  核心包，用于配置管理、翻译、[内容声明](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/content_file.md)、转译和 [CLI 命令](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/index.md)的国际化工具。
+
+- **vanilla-intlayer**
+  将 Intlayer 与纯 JavaScript / TypeScript 应用集成的包。它提供了一个发布/订阅单例 (`IntlayerClient`) 和基于回调的辅助函数 (`useIntlayer`、`useLocale` 等)，使您应用的任何部分都能在不依赖 UI 框架的情况下响应语言更改。
+
+> `intlayer standalone` CLI 的打包导出通过对您的配置中未使用的包、语言区域和非必要逻辑（如重定向或前缀）进行摇树优化（tree-shaking）来生成优化的构建版本。
+
+### 第二步：项目配置
+
+创建一个配置文件以配置您应用的语言：
+
+```typescript fileName="intlayer.config.ts" codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [
+      Locales.ENGLISH,
+      Locales.FRENCH,
+      Locales.SPANISH,
+      // 您的其他语言
+    ],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.mjs" codeFormat="esm"
+import { Locales } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  internationalization: {
+    locales: [
+      Locales.ENGLISH,
+      Locales.FRENCH,
+      Locales.SPANISH,
+      // 您的其他语言
+    ],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
+const { Locales } = require("intlayer");
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  internationalization: {
+    locales: [
+      Locales.ENGLISH,
+      Locales.FRENCH,
+      Locales.SPANISH,
+      // 您的其他语言
+    ],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+module.exports = config;
+```
+
+> 通过此配置文件，您可以设置本地化 URL、中间件重定向、Cookie 名称、内容声明的位置和扩展名、禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表，请参阅[配置文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md)。
+
+### 第三步：在 HTML 中导入 bundle
+
+生成 `intlayer.js` bundle 后，您可以将其导入到 HTML 文件中：
+
+```html fileName="index.html"
+<!DOCTYPE html>
+<html lang="zh">
+  <head>
+    <meta charset="UTF-8" />
+
+    <!-- 导入 bundle -->
+    <script src="./intlayer.js" defer></script>
+    <!-- 导入您的主脚本 -->
+    <script src="./src/main.js" defer></script>
+  </head>
+  <body>
+    <h1 id="title"></h1>
+    <p class="read-the-docs"></p>
+  </body>
+</html>
+```
+
+该 bundle 会将 `Intlayer` 和 `VanillaIntlayer` 暴露为 `window` 上的全局对象。
+
+### 第四步：在入口点引导 Intlayer
+
+在 `src/main.js` 中，**在**渲染任何内容之前调用 `installIntlayer()`，以便全局语言单例准备就绪。
+
+```javascript fileName="src/main.js"
+const { installIntlayer } = window.VanillaIntlayer;
+
+// 必须在渲染任何 i18n 内容之前调用。
+installIntlayer();
+```
+
+如果您还想使用 Markdown 渲染器，请调用 `installIntlayerMarkdown()`：
+
+```javascript fileName="src/main.js"
+const { installIntlayer, installIntlayerMarkdown } = window.VanillaIntlayer;
+
+installIntlayer();
+installIntlayerMarkdown();
+```
+
+### 第五步：声明您的内容
+
+创建并管理您的内容声明以存储翻译：
+
+```typescript fileName="src/app.content.ts" contentDeclarationFormat="typescript"
+import { insert, t, type Dictionary } from "intlayer";
+
+const appContent = {
+  key: "app",
+  content: {
+    title: "Vite + Vanilla",
+
+    viteLogoLabel: t({
+      en: "Vite Logo",
+      fr: "Logo Vite",
+      es: "Logo Vite",
+    }),
+
+    count: insert(
+      t({
+        en: "count is {{count}}",
+        fr: "le compte est {{count}}",
+        es: "el recuento es {{count}}",
+      })
+    ),
+
+    readTheDocs: t({
+      en: "Click on the Vite logo to learn more",
+      fr: "Cliquez sur le logo Vite pour en savoir plus",
+      es: "Haga clic en el logotipo de Vite para obtener más información",
+    }),
+  },
+} satisfies Dictionary;
+
+export default appContent;
+```
+
+```javascript fileName="src/app.content.mjs" contentDeclarationFormat="esm"
+import { insert, t } from "intlayer";
+
+/** @type {import('intlayer').Dictionary} */
+const appContent = {
+  key: "app",
+  content: {
+    title: "Vite + Vanilla",
+
+    viteLogoLabel: t({
+      en: "Vite Logo",
+      fr: "Logo Vite",
+      es: "Logo Vite",
+    }),
+
+    count: insert(
+      t({
+        en: "count is {{count}}",
+        fr: "le compte est {{count}}",
+        es: "el recuento es {{count}}",
+      })
+    ),
+
+    readTheDocs: t({
+      en: "Click on the Vite logo to learn more",
+      fr: "Cliquez sur le logo Vite pour en savoir plus",
+      es: "Haga clic en el logotipo de Vite para obtener más información",
+    }),
+  },
+};
+
+export default appContent;
+```
+
+```javascript fileName="src/app.content.cjs" contentDeclarationFormat="commonjs"
+const { insert, t } = require("intlayer");
+
+/** @type {import('intlayer').Dictionary} */
+const appContent = {
+  key: "app",
+  content: {
+    title: "Vite + Vanilla",
+
+    viteLogoLabel: t({
+      en: "Vite Logo",
+      fr: "Logo Vite",
+      es: "Logo Vite",
+    }),
+
+    count: insert(
+      t({
+        en: "count is {{count}}",
+        fr: "le compte est {{count}}",
+        es: "el recuento es {{count}}",
+      })
+    ),
+
+    readTheDocs: t({
+      en: "Click on the Vite logo to learn more",
+      fr: "Cliquez sur le logo Vite pour en savoir plus",
+      es: "点击 Vite 徽标了解更多信息",
+    }),
+  },
+};
+
+module.exports = appContent;
+```
+
+```json fileName="src/app.content.json" contentDeclarationFormat="json"
+{
+  "$schema": "https://intlayer.org/schema.json",
+  "key": "app",
+  "content": {
+    "title": "Vite + Vanilla",
+    "viteLogoLabel": {
+      "nodeType": "translation",
+      "translation": {
+        "en": "Vite Logo",
+        "fr": "Logo Vite",
+        "es": "Logo Vite"
+      }
+    },
+    "count": {
+      "nodeType": "insertion",
+      "insertion": {
+        "nodeType": "translation",
+        "translation": {
+          "en": "count is {{count}}",
+          "fr": "le compte est {{count}}",
+          "es": "el recuento es {{count}}"
+        }
+      }
+    },
+    "readTheDocs": {
+      "nodeType": "translation",
+      "translation": {
+        "en": "Click on the Vite logo to learn more",
+        "fr": "Cliquez sur le logo Vite pour en savoir plus",
+        "es": "Haga clic en el logotipo de Vite para obtener más información"
+      }
+    }
+  }
+}
+```
+
+> 只要您的内容声明包含在 `contentDir` 目录（默认为 `./src`）中，并且符合内容声明文件扩展名（默认为 `.content.{json,ts,tsx,js,jsx,mjs,cjs}`），您可以在应用的任何位置定义它们。
+>
+> 有关更多详细信息，请参阅[内容声明文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/content_file.md)。
+
+### 第六步：在 JavaScript 中使用 Intlayer
+
+`window.VanillaIntlayer` 对象提供了 API 辅助函数：`useIntlayer(key, locale?)` 返回给定键的翻译内容。
+
+```javascript fileName="src/main.js"
+const { installIntlayer, useIntlayer } = window.VanillaIntlayer;
+
+installIntlayer();
+
+// 获取当前语言的初始内容。
+// 链式调用 .onChange() 以在语言更改时获得通知。
+const content = useIntlayer("app").onChange((newContent) => {
+  // 仅重新渲染或修补受影响的 DOM 节点
+  document.querySelector("h1").textContent = String(newContent.title);
+  document.querySelector(".read-the-docs").textContent = String(
+    newContent.readTheDocs
+  );
+});
+
+// 初始渲染
+document.querySelector("h1").textContent = String(content.title);
+document.querySelector(".read-the-docs").textContent = String(
+  content.readTheDocs
+);
+```
+
+> 通过将叶子节点值包裹在 `String()` 中，将其作为字符串访问，这将调用节点的 `toString()` 方法并返回翻译后的文本。
+>
+> 当您需要原生 HTML 属性（如 `alt`、`aria-label`）的值时，请直接使用 `.value`：
+>
+> ```javascript
+> img.alt = content.viteLogoLabel.value;
+> ```
+
+### （可选）第七步：更改内容语言
+
+要更改内容的语言，请使用 `useLocale` 暴露的 `setLocale` 函数。
+
+```javascript fileName="src/locale-switcher.js"
+const { getLocaleName } = window.Intlayer;
+const { useLocale } = window.VanillaIntlayer;
+
+export function setupLocaleSwitcher(container) {
+  const { locale, availableLocales, setLocale, subscribe } = useLocale();
+
+  const select = document.createElement("select");
+  select.setAttribute("aria-label", "语言");
+
+  const render = (currentLocale) => {
+    select.innerHTML = availableLocales
+      .map(
+        (loc) =>
+          `<option value="${loc}"${loc === currentLocale ? " selected" : ""}>
+            ${getLocaleName(loc)}
+          </option>`
+      )
+      .join("");
+  };
+
+  render(locale);
+  container.appendChild(select);
+
+  select.addEventListener("change", () => setLocale(select.value));
+
+  // 当从其他地方更改语言时，保持下拉菜单同步
+  return subscribe((newLocale) => render(newLocale));
+}
+```
+
+### （可选）第八步：切换 HTML 语言和方向属性
+
+根据当前语言更新 `<html>` 标签的 `lang` 和 `dir` 属性，以满足辅助功能和 SEO 的要求。
+
+```javascript fileName="src/main.js"
+const { getHTMLTextDir } = window.Intlayer;
+const { installIntlayer, useLocale } = window.VanillaIntlayer;
+
+installIntlayer();
+
+useLocale({
+  onLocaleChange: (locale) => {
+    document.documentElement.lang = locale;
+    document.documentElement.dir = getHTMLTextDir(locale);
+  },
+});
+```
+
+### （可选）第九步：按需加载（Lazy-load）语言字典
+
+如果您想按需加载字典，可以使用 `useDictionaryDynamic`。如果您不想在初始的 `intlayer.js` 文件中打包所有翻译，这非常有用。
+
+```javascript fileName="src/app.js"
+const { installIntlayer, useDictionaryDynamic } = window.VanillaIntlayer;
+
+installIntlayer();
+
+const unsubscribe = useDictionaryDynamic(
+  {
+    en: () => import("../.intlayer/dictionaries/en/app.mjs"),
+    fr: () => import("../.intlayer/dictionaries/fr/app.mjs"),
+    es: () => import("../.intlayer/dictionaries/es/app.mjs"),
+  },
+  "app"
+).onChange((content) => {
+  document.querySelector("h1").textContent = String(content.title);
+});
+```
+
+> 注意：`useDictionaryDynamic` 要求字典作为单独的 ESM 文件可用。如果您的 Web 服务器负责提供这些字典，通常会使用这种方法。
+
+### 配置 TypeScript
+
+确保您的 TypeScript 配置包含自动生成的类型。
+
+```json5 fileName="tsconfig.json"
+{
+  "compilerOptions": {
+    // ...
+  },
+  "include": ["src", ".intlayer/**/*.ts"],
+}
+```
+
+### VS Code 扩展
+
+为了提升使用 Intlayer 的开发体验，您可以安装官方的 **Intlayer VS Code 扩展**。
+
+[从 VS Code Marketplace 安装](https://marketplace.visualstudio.com/items?itemName=intlayer.intlayer-vs-code-extension)
+
+该扩展提供：
+
+- 翻译键的**自动补全**。
+- 缺失翻译的**实时错误检测**。
+- 翻译内容的**内联预览**。
+- 轻松创建和更新翻译的**快速操作**。
+
+有关如何使用该扩展的更多详细信息，请参阅 [Intlayer VS Code 扩展文档](https://intlayer.org/doc/vs-code-extension)。
+
+---
+
+### 深入了解
+
+若要深入了解，您可以实现[可视化编辑器](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_visual_editor.md)或使用 [CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_CMS.md) 外置您的内容。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/docs",
-  "version": "8.6.0",
+  "version": "8.6.10",
   "private": false,
   "description": "Intlayer documentation",
   "keywords": [
@@ -72,14 +72,14 @@
     "watch": "webpack --config ./webpack.config.ts --watch"
   },
   "dependencies": {
-    "@intlayer/config": "8.6.0",
-    "@intlayer/core": "8.6.0",
-    "@intlayer/types": "8.6.0"
+    "@intlayer/config": "8.6.10",
+    "@intlayer/core": "8.6.10",
+    "@intlayer/types": "8.6.10"
   },
   "devDependencies": {
-    "@intlayer/api": "8.6.0",
-    "@intlayer/cli": "8.6.0",
-    "@types/node": "25.5.0",
+    "@intlayer/api": "8.6.10",
+    "@intlayer/cli": "8.6.10",
+    "@types/node": "25.5.2",
     "@utils/ts-config": "1.0.4",
     "@utils/ts-config-types": "1.0.4",
     "@utils/tsdown-config": "1.0.4",
@@ -87,7 +87,7 @@
     "rimraf": "6.1.3",
     "tsdown": "0.21.7",
     "typescript": "6.0.2",
-    "vitest": "4.1.2"
+    "vitest": "4.1.3"
   },
   "engines": {
     "node": ">=14.18"

package/src/doc.ts

@@ -1,4 +1,7 @@
-import type { DeclaredLocales, LocalesValues } from '@intlayer/types/module_augmentation';
+import type {
+  DeclaredLocales,
+  LocalesValues,
+} from '@intlayer/types/module_augmentation';
 import {
   defaultLocale,
   type FileMetadata,

package/src/generated/docs.entry.ts

@@ -493,6 +493,26 @@ export const docsEntry = {
     vi: readLocale('cli/sdk.md', 'vi'),
     uk: readLocale('cli/sdk.md', 'uk'),
   } as unknown as Record<LocalesValues, Promise<string>>,
+  './docs/en/cli/standalone.md': {
+    en: readLocale('cli/standalone.md', 'en'),
+    ru: readLocale('cli/standalone.md', 'ru'),
+    ja: readLocale('cli/standalone.md', 'ja'),
+    fr: readLocale('cli/standalone.md', 'fr'),
+    ko: readLocale('cli/standalone.md', 'ko'),
+    zh: readLocale('cli/standalone.md', 'zh'),
+    es: readLocale('cli/standalone.md', 'es'),
+    de: readLocale('cli/standalone.md', 'de'),
+    ar: readLocale('cli/standalone.md', 'ar'),
+    it: readLocale('cli/standalone.md', 'it'),
+    'en-GB': readLocale('cli/standalone.md', 'en-GB'),
+    pt: readLocale('cli/standalone.md', 'pt'),
+    hi: readLocale('cli/standalone.md', 'hi'),
+    tr: readLocale('cli/standalone.md', 'tr'),
+    pl: readLocale('cli/standalone.md', 'pl'),
+    id: readLocale('cli/standalone.md', 'id'),
+    vi: readLocale('cli/standalone.md', 'vi'),
+    uk: readLocale('cli/standalone.md', 'uk'),
+  } as unknown as Record<LocalesValues, Promise<string>>,
   './docs/en/cli/test.md': {
     en: readLocale('cli/test.md', 'en'),
     ru: readLocale('cli/test.md', 'ru'),
@@ -613,6 +633,26 @@ export const docsEntry = {
     vi: readLocale('configuration.md', 'vi'),
     uk: readLocale('configuration.md', 'uk'),
   } as unknown as Record<LocalesValues, Promise<string>>,
+  './docs/en/custom_domains.md': {
+    en: readLocale('custom_domains.md', 'en'),
+    ru: readLocale('custom_domains.md', 'ru'),
+    ja: readLocale('custom_domains.md', 'ja'),
+    fr: readLocale('custom_domains.md', 'fr'),
+    ko: readLocale('custom_domains.md', 'ko'),
+    zh: readLocale('custom_domains.md', 'zh'),
+    es: readLocale('custom_domains.md', 'es'),
+    de: readLocale('custom_domains.md', 'de'),
+    ar: readLocale('custom_domains.md', 'ar'),
+    it: readLocale('custom_domains.md', 'it'),
+    'en-GB': readLocale('custom_domains.md', 'en-GB'),
+    pt: readLocale('custom_domains.md', 'pt'),
+    hi: readLocale('custom_domains.md', 'hi'),
+    tr: readLocale('custom_domains.md', 'tr'),
+    pl: readLocale('custom_domains.md', 'pl'),
+    id: readLocale('custom_domains.md', 'id'),
+    vi: readLocale('custom_domains.md', 'vi'),
+    uk: readLocale('custom_domains.md', 'uk'),
+  } as unknown as Record<LocalesValues, Promise<string>>,
   './docs/en/custom_url_rewrites.md': {
     en: readLocale('custom_url_rewrites.md', 'en'),
     ru: readLocale('custom_url_rewrites.md', 'ru'),
@@ -1493,6 +1533,26 @@ export const docsEntry = {
     vi: readLocale('intlayer_with_tanstack.md', 'vi'),
     uk: readLocale('intlayer_with_tanstack.md', 'uk'),
   } as unknown as Record<LocalesValues, Promise<string>>,
+  './docs/en/intlayer_with_vanilla.md': {
+    en: readLocale('intlayer_with_vanilla.md', 'en'),
+    ru: readLocale('intlayer_with_vanilla.md', 'ru'),
+    ja: readLocale('intlayer_with_vanilla.md', 'ja'),
+    fr: readLocale('intlayer_with_vanilla.md', 'fr'),
+    ko: readLocale('intlayer_with_vanilla.md', 'ko'),
+    zh: readLocale('intlayer_with_vanilla.md', 'zh'),
+    es: readLocale('intlayer_with_vanilla.md', 'es'),
+    de: readLocale('intlayer_with_vanilla.md', 'de'),
+    ar: readLocale('intlayer_with_vanilla.md', 'ar'),
+    it: readLocale('intlayer_with_vanilla.md', 'it'),
+    'en-GB': readLocale('intlayer_with_vanilla.md', 'en-GB'),
+    pt: readLocale('intlayer_with_vanilla.md', 'pt'),
+    hi: readLocale('intlayer_with_vanilla.md', 'hi'),
+    tr: readLocale('intlayer_with_vanilla.md', 'tr'),
+    pl: readLocale('intlayer_with_vanilla.md', 'pl'),
+    id: readLocale('intlayer_with_vanilla.md', 'id'),
+    vi: readLocale('intlayer_with_vanilla.md', 'vi'),
+    uk: readLocale('intlayer_with_vanilla.md', 'uk'),
+  } as unknown as Record<LocalesValues, Promise<string>>,
   './docs/en/intlayer_with_vite+lit.md': {
     en: readLocale('intlayer_with_vite+lit.md', 'en'),
     ru: readLocale('intlayer_with_vite+lit.md', 'ru'),