@intlayer/docs 9.1.3 → 9.3.0

package/docs/zh/intlayer_with_tanstack+solid.md

@@ -73,9 +73,296 @@ Intlayer 不仅仅是一个 i18n 解决方案，还提供了一个**自托管的
 
 ---
 
-### 第 8 步：利用语言感知的组件和钩子
+## 在 Tanstack Start 应用中设置 Intlayer 的分步指南
 
-为语言敏感的导航创建一个 `LocalizedLink` 组件：
+<Tabs defaultTab="video">
+  <Tab label="视频" value="video">
+
+<iframe title="The best i18n solution for Tanstack Start? Discover Intlayer" class="m-auto aspect-16/9 w-full overflow-hidden rounded-lg border-0" allow="autoplay; gyroscope;" loading="lazy" width="1080" height="auto" src="https://www.youtube.com/embed/_XTdKVWaeqg?autoplay=0&amp;origin=https://intlayer.org&amp;controls=0&amp;rel=1"/>
+
+  </Tab>
+  <Tab label="代码" value="code">
+
+<iframe
+  src="https://ide.intlayer.org/aymericzip/intlayer-tanstack-start-solid-template?file=intlayer.config.ts"
+  className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
+  title="Demo CodeSandbox - How to Internationalize your application using Intlayer"
+  sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
+  loading="lazy"
+/>
+
+  </Tab>
+  <Tab label="演示" value="demo">
+
+<iframe
+  src="https://intlayer-tanstack-start-solid.vercel.app"
+  className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
+  title="Demo - intlayer-tanstack-start-solid-template"
+  sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
+  loading="lazy"
+/>
+
+  </Tab>
+</Tabs>
+
+参见 GitHub 上的[应用模板](https://github.com/aymericzip/intlayer-tanstack-start-solid-template)。
+
+<Steps>
+
+<Step number={1} title="创建项目">
+
+首先按照 TanStack Start 网站上的[新建项目](https://tanstack.com/start/latest/docs/framework/solid/quick-start)指南创建一个新的 TanStack Start 项目。
+
+</Step>
+
+<Step number={2} title="安装 Intlayer 包">
+
+使用您首选的包管理器安装必要的包：
+
+```bash packageManager="npm"
+npx intlayer init --interactive
+```
+
+```bash packageManager="pnpm"
+pnpm dlx intlayer@canary init --interactive
+```
+
+```bash packageManager="yarn"
+yarn dlx intlayer@canary init --interactive
+```
+
+```bash packageManager="bun"
+bunx intlayer@canary init --interactive
+```
+
+> `--interactive` 标志是可选的。如果您是 AI agent，请使用 `intlayer-cli init`。
+
+> 此命令将检测您的环境并安装所需的包。例如：
+
+```bash packageManager="npm"
+npm install intlayer solid-intlayer
+npm install vite-intlayer --save-dev
+```
+
+```bash packageManager="pnpm"
+pnpm add intlayer solid-intlayer
+pnpm add vite-intlayer --save-dev
+```
+
+```bash packageManager="yarn"
+yarn add intlayer solid-intlayer
+yarn add vite-intlayer --save-dev
+```
+
+```bash packageManager="bun"
+bun add intlayer solid-intlayer
+bun add vite-intlayer --dev
+```
+
+- **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)。
+
+- **solid-intlayer**
+  将 Intlayer 与 Solid 应用程序集成的包。它为 Solid 国际化提供上下文提供者和 hooks。
+
+- **vite-intlayer**
+  包含用于将 Intlayer 与 [Vite bundler](https://vite.dev/guide/why.html#why-bundle-for-production) 集成的 Vite 插件，以及用于检测用户首选语言环境、管理 cookies 和处理 URL 重定向的中间件。
+
+</Step>
+
+<Step number={3} title="配置您的项目">
+
+创建一个配置文件来配置应用程序的语言：
+
+```typescript fileName="intlayer.config.ts"
+import type { IntlayerConfig } from "intlayer";
+
+import { Locales } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    defaultLocale: Locales.ENGLISH,
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  },
+};
+
+export default config;
+```
+
+> 通过此配置文件，您可以设置本地化的 URL、中间件重定向、cookie 名称、内容声明的位置和扩展名、禁用控制台中的 Intlayer 日志等。关于可用参数的完整列表，请参考[配置文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md)。
+
+</Step>
+
+<Step number={4} title="在您的 Vite 配置中集成 Intlayer">
+
+将 intlayer 插件添加到您的配置中：
+
+```typescript fileName="vite.config.ts"
+import { intlayer } from "vite-intlayer";
+import { defineConfig } from "vite";
+import { devtools } from "@tanstack/devtools-vite";
+import { tanstackStart } from "@tanstack/solid-start/plugin/vite";
+import solidPlugin from "vite-plugin-solid";
+
+export default defineConfig({
+  plugins: [
+    devtools(),
+    tanstackStart({
+      router: {
+        routeFileIgnorePattern:
+          ".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5|md|mdx|yaml|yml)$",
+      },
+    }),
+    solidPlugin({ ssr: true }),
+    intlayer({
+      proxy: {
+        ignore: (req) => req.url?.startsWith("/api"),
+      },
+    }),
+  ],
+});
+```
+
+> `intlayer()` Vite 插件用于将 Intlayer 与 Vite 集成。它确保内容声明文件的构建并在开发模式下监控它们。它在 Vite 应用程序中定义 Intlayer 环境变量。此外，它提供别名以优化性能。
+
+</Step>
+
+<Step number={5} title="创建根布局">
+
+通过使用 `useParams` 检测当前语言环境并在 `html` 标签上设置 `lang` 和 `dir` 属性来配置您的根布局以支持国际化。
+
+```tsx fileName="src/routes/__root.tsx"
+import {
+  HeadContent,
+  Scripts,
+  createRootRouteWithContext,
+} from "@tanstack/solid-router";
+import { HydrationScript } from "solid-js/web";
+import { Suspense, type ParentComponent } from "solid-js";
+import { IntlayerProvider } from "solid-intlayer";
+import { defaultLocale, getHTMLTextDir } from "intlayer";
+import { Route as LocaleRoute } from "./{-$locale}/route";
+
+export const Route = createRootRouteWithContext()({
+  shellComponent: RootComponent,
+});
+
+const RootComponent: ParentComponent = (props) => {
+  const params = LocaleRoute.useParams();
+  const locale = params()?.locale ?? defaultLocale;
+
+  return (
+    <html dir={getHTMLTextDir(locale)} lang={locale}>
+      <head>
+        <HydrationScript />
+        <HeadContent />
+      </head>
+      <body>
+        <IntlayerProvider locale={locale}>
+          <Suspense>{props.children}</Suspense>
+        </IntlayerProvider>
+        <Scripts />
+      </body>
+    </html>
+  );
+};
+```
+
+</Step>
+
+<Step number={6} title="创建语言环境布局">
+
+创建一个处理语言环境前缀并执行验证的布局。此布局将确保仅处理有效的语言环境。
+
+> 如果您不需要在路由级别验证语言环境前缀，此步骤是可选的。
+
+```tsx fileName="src/routes/{-$locale}/route.tsx"
+import { createFileRoute, Outlet, redirect } from "@tanstack/solid-router";
+import { validatePrefix } from "intlayer";
+
+export const Route = createFileRoute("/{-$locale}")({
+  beforeLoad: ({ params }) => {
+    const localeParam = params.locale;
+
+    // 验证语言环境前缀
+    const { isValid, localePrefix } = validatePrefix(localeParam);
+
+    if (!isValid) {
+      throw redirect({
+        to: "/{-$locale}/404",
+        params: { locale: localePrefix },
+        replace: true,
+      });
+    }
+  },
+  component: Outlet,
+});
+```
+
+> 此处，`{-$locale}` 是一个动态路由参数，将被替换为当前的语言环境。这种符号使 slot 成为可选的，允许它与诸如 `'prefix-no-default'` 等路由模式一起使用。
+
+> 请注意，如果您在同一路由中使用多个动态段（例如 `/{-$locale}/other-path/$anotherDynamicPath/...`），此 slot 可能会导致问题。
+> 对于 `'prefix-all'` 模式，您可能更倾向于将 slot 切换为 `$locale`。
+> 对于 `'no-prefix'` 或 `'search-params'` 模式，您可以完全删除 slot。
+
+</Step>
+
+<Step number={7} title="声明您的内容">
+
+创建和管理您的内容声明以存储翻译：
+
+```tsx fileName="src/contents/page.content.ts"
+import type { Dictionary } from "intlayer";
+
+import { t } from "intlayer";
+
+const appContent = {
+  content: {
+    links: {
+      about: t({
+        zh: "关于",
+        en: "About",
+        es: "Acerca de",
+        fr: "À propos",
+      }),
+      home: t({
+        zh: "主页",
+        en: "Home",
+        es: "Inicio",
+        fr: "Accueil",
+      }),
+    },
+    meta: {
+      title: t({
+        zh: "欢迎来到 Intlayer + TanStack Router",
+        en: "Welcome to Intlayer + TanStack Router",
+        es: "Bienvenido a Intlayer + TanStack Router",
+        fr: "Bienvenue à Intlayer + TanStack Router",
+      }),
+      description: t({
+        zh: "这是一个使用 Intlayer 与 TanStack Router 的示例",
+        en: "This is an example of using Intlayer with TanStack Router",
+        es: "Este es un ejemplo de uso de Intlayer con TanStack Router",
+        fr: "Ceci est un exemple d'utilisation d'Intlayer avec TanStack Router",
+      }),
+    },
+  },
+  key: "app",
+} satisfies Dictionary;
+
+export default appContent;
+```
+
+> 您的内容声明可以在应用程序中的任何位置定义，只要它们包含在 `contentDir` 目录中（默认为 `./app`）。并匹配内容声明文件扩展名（默认为 `.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml}`）。
+
+> 有关更多详情，请参考[内容声明文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/content_file.md)。
+
+</Step>
+
+<Step number={7} title="创建语言环境感知组件和 Hooks">
+
+为本地化导航创建一个 `LocalizedLink` 组件：
 
 ```tsx fileName="src/components/LocalizedLink.tsx"
 import { Link, type LinkProps } from "@tanstack/solid-router";
@@ -127,12 +414,12 @@ export const LocalizedLink = (props: LocalizedLinkProps) => {
 };
 ```
 
-此组件有两个目的：
+此组件有两个目标：
 
 - 从 URL 中删除不必要的 `{-$locale}` 前缀。
-- 在 URL 中注入语言参数，以确保用户直接重定向到本地化路由。
+- 将语言环境参数注入到 URL 中，以确保用户直接重定向到本地化的路由。
 
-接着，我们可以为编程式导航创建一个 `useLocalizedNavigate` 钩子：
+然后我们可以创建一个 `useLocalizedNavigate` hook 用于编程导航：
 
 ```tsx fileName="src/hooks/useLocalizedNavigate.tsx"
 import { useNavigate } from "@tanstack/solid-router";
@@ -152,9 +439,56 @@ export const useLocalizedNavigate = () => {
 };
 ```
 
-### 第 10 步：创建一个语言切换组件
+</Step>
+
+<Step number={8} title="在您的页面中使用 Intlayer">
+
+在整个应用程序中访问您的内容字典：
+
+#### 本地化主页
+
+```tsx fileName="src/routes/{-$locale}/index.tsx"
+import { createFileRoute } from "@tanstack/solid-router";
+import { useIntlayer } from "solid-intlayer";
+import { LocalizedLink } from "@/components/LocalizedLink";
+
+export const Route = createFileRoute("/{-$locale}/")({
+  component: RouteComponent,
+});
+
+function RouteComponent() {
+  const content = useIntlayer("index-page");
+
+  return (
+    <main>
+      <h1>{content.heroTitle}</h1>
+      <p>{content.heroDesc}</p>
+      <div>
+        <LocalizedLink to="/">{content.navHome}</LocalizedLink>
+        <LocalizedLink to="/about">{content.navAbout}</LocalizedLink>
+      </div>
+    </main>
+  );
+}
+```
+
+> 在 Solid 中，`useIntlayer` 返回反应式内容（例如 `content`）。您可以直接访问其属性。
+>
+> 如果您想在 `string` 属性中使用您的内容，例如 `alt`、`title`、`href`、`aria-label` 等，可以使用函数的值，如下所示：
+>
+> ```html
+> <img src="{content.image.src.value}" alt="{content.image.value}" />
+> <img src="{content.image.src.toString()}" alt="{content.image.toString()}" />
+> <img src="{String(content.image.src)}" alt="{String(content.image)}" />
+> ```
+
+> 要了解更多关于 `useIntlayer` hook 的信息，请参考[文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useIntlayer.md)。
+
+</Step>
 
-创建一个允许用户更改语言的组件：
+<Step number={9} title="创建语言切换器组件">
+
+创建一个组件以允许用户更改语言：
 
 ```tsx fileName="src/components/LocaleSwitcher.tsx"
 import { useLocation } from "@tanstack/solid-router";
@@ -192,17 +526,359 @@ export const LocaleSwitcher = () => {
 export default LocaleSwitcher;
 ```
 
-> 在 Solid 中，来自 `useLocale` 的 `locale` 是一个 **signal accessor**。请使用 `locale()` (带括号) 来响应式地读取其当前值。
+> 在 Solid 中，来自 `useLocale` 的 `locale` 是一个**信号访问器**。使用 `locale()`（带括号）以反应式方式读取其当前值。
 >
-> 欲了解更多关于 `useLocale` 钩子的信息，请参考[文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useLocale.md)。
+> 要了解更多关于 `useLocale` hook 的信息，请参考[文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/solid-intlayer/useLocale.md)。
+
+</Step>
+
+<Step number={10} title="HTML 属性管理">
+
+如步骤 5 所示，您可以在根组件中使用 `useParams` 管理 `html` 标签的 `lang` 和 `dir` 属性。这确保在服务器和客户端上正确设置属性。
+
+```tsx fileName="src/routes/__root.tsx"
+const RootComponent: ParentComponent = (props) => {
+  const params = LocaleRoute.useParams();
+  const locale = params()?.locale ?? defaultLocale;
+
+  return (
+    <html dir={getHTMLTextDir(locale)} lang={locale}>
+      {/* ... */}
+    </html>
+  );
+};
+```
 
-### 第 16 步：生成站点地图 (可选)
+---
+
+</Step>
+
+<Step number={11} title="添加中间件">
 
-Intlayer 带有内置的站点地图生成器，可帮助您轻松为应用程序创建站点地图。它处理本地化路由并为搜索引擎添加必要的元数据。
+您也可以使用 `intlayerProxy` 为您的应用程序添加服务器端路由。该插件将自动根据 URL 检测当前语言环境并设置适当的语言环境 cookie。如果未指定语言环境，该插件将根据用户的浏览器语言首选项确定最合适的语言环境。如果未检测到语言环境，它将重定向到默认语言环境。
 
-> Intlayer 生成的站点地图支持 `xhtml:link` 命名空间（Hreflang XML 扩展）。与仅列出原始 URL 的默认站点地图生成器不同，Intlayer 会自动在页面的所有语言版本（例如 `/about`、`/about?lang=fr` 和 `/about?lang=es`）之间创建所需的双向链接。这确保了搜索引擎能够正确索引并向合适的受众提供正确的语言版本。
+> 注意，要在生产环境中使用 `intlayerProxy`，您需要将 `vite-intlayer` 包从 `devDependencies` 切换到 `dependencies`。
 
-要使用它，您首先需要配置 `vite.config.ts` 以启用本地化路由的预渲染，并禁用 TanStack Start 的默认站点地图生成。
+> 从 Intlayer v9 开始，`intlayerProxy()` 直接捆绑到 `intlayer()` 插件中，并通过 `routing.enableProxy` 选项（默认为 `true`）默认启用。如下所示单独注册现在是可选的 — 为了向后兼容性以及需要控制插件顺序的设置而保留。设置 `routing.enableProxy: false` 以选择退出。参考 [v9 发布说明](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/releases/v9.md)。
+
+```typescript fileName="vite.config.ts"
+import { tanstackStart } from "@tanstack/solid-start/plugin/vite";
+import solid from "vite-plugin-solid";
+import { nitro } from "nitro/vite";
+import { defineConfig } from "vite";
+import { intlayer } from "vite-intlayer";
+
+export default defineConfig({
+  plugins: [
+    nitro(),
+    intlayer({
+      proxy: {
+        ignore: (req) => req.url?.startsWith("/api"),
+      },
+    }),
+    tanstackStart({
+      router: {
+        routeFileIgnorePattern:
+          ".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5|md|mdx|yaml|yml)$",
+      },
+    }),
+    solid(),
+  ],
+});
+```
+
+---
+
+</Step>
+
+<Step number={12} title="国际化您的元数据">
+
+您也可以使用 `getIntlayer` 函数在 `head` 加载器内访问您的内容字典以获取语言环境感知的元数据：
+
+```tsx fileName="src/routes/{-$locale}/index.tsx"
+import { createFileRoute } from "@tanstack/solid-router";
+import { getIntlayer } from "intlayer";
+
+export const Route = createFileRoute("/{-$locale}/")({
+  component: RouteComponent,
+  head: ({ params }) => {
+    const { locale } = params;
+    const path = "/"; // 此路由的路径
+
+    const metaContent = getIntlayer("app", locale);
+
+    return {
+      links: [
+        // 规范链接：指向当前本地化页面
+        { rel: "canonical", href: getLocalizedUrl(path, locale) },
+
+        // Hreflang：告知 Google 所有本地化版本
+        ...localeMap(({ locale: mapLocale }) => ({
+          rel: "alternate",
+          hrefLang: mapLocale,
+          href: getLocalizedUrl(path, mapLocale),
+        })),
+
+        // x-default：针对不匹配语言的用户
+        // 定义默认回退语言环境（通常是您的主要语言）
+        {
+          rel: "alternate",
+          hrefLang: "x-default",
+          href: getLocalizedUrl(path, defaultLocale),
+        },
+      ],
+      meta: [
+        { title: metaContent.title },
+        { name: "description", content: metaContent.meta.description },
+      ],
+    };
+  },
+});
+```
+
+---
+
+</Step>
+
+<Step number={13} title="在服务器操作中检索语言环境">
+
+您可能希望从服务器操作或 API 端点内部访问当前语言环境。
+您可以使用 `intlayer` 中的 `getLocale` helper。
+
+以下是使用 TanStack Start 的服务器函数的示例：
+
+```tsx fileName="src/routes/{-$locale}/index.tsx"
+import { createServerFn } from "@tanstack/solid-start";
+import {
+  getRequestHeader,
+  getRequestHeaders,
+} from "@tanstack/solid-start/server";
+import { getCookie, getIntlayer, getLocale } from "intlayer";
+
+export const getLocaleServer = createServerFn().handler(async () => {
+  const locale = await getLocale({
+    // 从请求中获取 cookie（默认值：'INTLAYER_LOCALE'）
+    getCookie: (name) => {
+      const cookieString = getRequestHeader("cookie");
+
+      return getCookie(name, cookieString);
+    },
+    // 从请求中获取标头（默认值：'x-intlayer-locale'）
+    // 使用 Accept-Language 协商的回退
+    getHeader: (name) => getRequestHeader(name),
+  });
+
+  // 使用 getIntlayer() 检索一些内容
+  const content = getIntlayer("app", locale);
+
+  return { locale, content };
+});
+```
+
+---
+
+</Step>
+
+<Step number={14} title="管理未找到页面">
+
+当用户访问不存在的页面时，您可以显示自定义的未找到页面，语言环境前缀可能会影响未找到页面的触发方式。
+
+#### 理解 TanStack Router 的 404 处理与区域设置前缀
+
+在 TanStack Router 中，处理带有本地化路由的 404 页面需要多层次的方法：
+
+1. **专用 404 路由**：用于显示 404 UI 的特定路由
+2. **路由级验证**：验证区域设置前缀并将无效的前缀重定向到 404
+3. **全能路由**：捕获区域设置段内所有不匹配的路径
+
+```tsx fileName="src/routes/{-$locale}/404.tsx"
+import { createFileRoute } from "@tanstack/solid-router";
+
+// 这创建了一个专用的 /[locale]/404 路由
+// 它既可用作直接路由，也可在其他文件中作为组件导入
+export const Route = createFileRoute("/{-$locale}/404")({
+  component: NotFoundComponent,
+});
+
+// 单独导出，以便在 notFoundComponent 和全能路由中重用
+export function NotFoundComponent() {
+  return (
+    <div>
+      <h1>404</h1>
+    </div>
+  );
+}
+```
+
+```tsx fileName="src/routes/{-$locale}/route.tsx"
+import { createFileRoute, Outlet, redirect } from "@tanstack/solid-router";
+import { validatePrefix } from "intlayer";
+import { NotFoundComponent } from "./404";
+
+export const Route = createFileRoute("/{-$locale}")({
+  // beforeLoad 在路由渲染前运行（在服务器和客户端上）
+  // 这是验证区域设置前缀的理想位置
+  beforeLoad: ({ params }) => {
+    const localeParam = params.locale;
+
+    // validatePrefix 检查区域设置是否根据你的 intlayer 配置有效
+    const { isValid, localePrefix } = validatePrefix(localeParam);
+
+    if (!isValid) {
+      // 无效的区域设置前缀 - 使用有效的区域设置前缀重定向到 404 页面
+      throw redirect({
+        to: "/{-$locale}/404",
+        params: { locale: localePrefix },
+      });
+    }
+  },
+  component: Outlet,
+  // notFoundComponent 在子路由不存在时被调用
+  // 例如，/en/non-existent-page 在 /en 布局内触发这个
+  notFoundComponent: NotFoundComponent,
+});
+```
+
+```tsx fileName="src/routes/{-$locale}/$.tsx"
+import { createFileRoute } from "@tanstack/solid-router";
+
+import { NotFoundComponent } from "./404";
+
+// $ (splat/全能) 路由匹配任何不匹配其他路由的路径
+// 例如，/en/some/deeply/nested/invalid/path
+// 这确保区域设置内的所有不匹配路径都显示 404 页面
+// 没有这个，不匹配的深层路径可能会显示空白页或错误
+export const Route = createFileRoute("/{-$locale}/$")({
+  component: NotFoundComponent,
+});
+```
+
+</Step>
+
+<Step number={15} title="提取你的组件内容" isOptional={true}>
+
+如果你有现有的代码库，转换数千个文件可能很耗时。
+
+为了简化这个过程，Intlayer 提供了一个 [compiler](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/compiler.md) / [extractor](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/cli/extract.md) 来转换你的组件和提取内容。
+
+要设置它，你可以在你的 `intlayer.config.ts` 文件中添加一个 `compiler` 部分：
+
+```typescript fileName="intlayer.config.ts" codeFormat={["typescript", "esm", "commonjs"]}
+import { type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  // ... 你的配置的其余部分
+  compiler: {
+    /**
+     * 指示编译器是否应该被启用。
+     */
+    enabled: true,
+
+    /**
+     * 定义输出文件路径
+     */
+    output: ({ fileName, extension }) => `./${fileName}${extension}`,
+
+    /**
+     * 指示转换后的组件是否应该被保存。
+     *
+     * - 如果为 `true`，编译器将在磁盘中重写组件文件。所以转换将是永久的，编译器将在下一个过程中跳过转换。这样，编译器可以转换应用，然后可以被移除。
+     *
+     * - 如果为 `false`，编译器将仅在构建输出中注入 `useIntlayer()` 函数调用，并保持基础代码库完整。转换将仅在内存中完成。
+     */
+    saveComponents: false,
+
+    /**
+     * 字典键前缀
+     */
+    dictionaryKeyPrefix: "",
+  },
+};
+
+export default config;
+```
+
+<Tabs>
+ <Tab value='提取命令'>
+
+运行提取器来转换你的组件和提取内容
+
+```bash packageManager="npm"
+npx intlayer extract
+```
+
+```bash packageManager="pnpm"
+pnpm intlayer extract
+```
+
+```bash packageManager="yarn"
+yarn intlayer extract
+```
+
+```bash packageManager="bun"
+bun x intlayer extract
+```
+
+ </Tab>
+ <Tab value='Babel 编译器'>
+
+> 从 v9 开始，`intlayerCompiler` 已包含在 `intlayer` 插件中。所以你不需要手动添加它。
+
+更新你的 `vite.config.ts` 以包含 `intlayerCompiler` 插件：
+
+```ts fileName="vite.config.ts"
+import { intlayer, intlayerCompiler } from "vite-intlayer";
+import { defineConfig } from "vite";
+import { devtools } from "@tanstack/devtools-vite";
+import { tanstackStart } from "@tanstack/solid-start/plugin/vite";
+import solidPlugin from "vite-plugin-solid";
+
+export default defineConfig({
+  plugins: [
+    devtools(),
+    tanstackStart({
+      router: {
+        routeFileIgnorePattern:
+          ".content.(ts|tsx|js|mjs|cjs|jsx|json|jsonc|json5|md|mdx|yaml|yml)$",
+      },
+    }),
+    solidPlugin({ ssr: true }),
+    intlayer(),
+    intlayerCompiler(), // 添加编译器插件
+  ],
+});
+```
+
+```bash packageManager="npm"
+npm run build # 或 npm run dev
+```
+
+```bash packageManager="pnpm"
+pnpm run build # 或 pnpm run dev
+```
+
+```bash packageManager="yarn"
+yarn build # 或 yarn dev
+```
+
+```bash packageManager="bun"
+bun run build # 或 bun run dev
+```
+
+ </Tab>
+</Tabs>
+
+---
+
+</Step>
+
+<Step number={16} title="预渲染和生成 Sitemap">
+
+Intlayer 配备了内置的 sitemap 生成器，可以帮助你轻松为应用创建 sitemap。它处理本地化路由并为搜索引擎添加必要的元数据。
+
+> Intlayer 生成的 sitemap 支持 `xhtml:link` 命名空间（Hreflang XML 扩展）。与仅列出原始 URL 的默认 sitemap 生成器不同，Intlayer 会自动创建页面所有语言版本之间所需的双向链接（例如 `/about`、`/about?lang=fr` 和 `/about?lang=es`）。这确保搜索引擎正确索引并为正确的受众提供正确的语言版本。
+
+要使用它，你首先需要配置你的 `vite.config.ts` 以启用本地化路由的预渲染并禁用默认的 TanStack Start sitemap 生成。
 
 ```typescript fileName="vite.config.ts"
 import { localeMap, localeFlatMap } from "intlayer";
@@ -269,6 +945,30 @@ export const Route = createFileRoute("/sitemap.xml")({
 
 ---
 
+</Step>
+
+<Step number={17} title="配置 TypeScript">
+
+Intlayer 使用模块扩展来获得 TypeScript 的好处并使你的代码库更强大。
+
+确保你的 TypeScript 配置包含自动生成的类型：
+
+```json5 fileName="tsconfig.json"
+{
+  // ... 你现有的配置
+  include: [
+    // ... 你现有的 include
+    ".intlayer/**/*.ts", // 包含自动生成的类型
+  ],
+}
+```
+
+---
+
+</Step>
+
+</Steps>
+
 ### Git 配置
 
 建议忽略 Intlayer 生成的文件。这可以避免将它们提交到您的 Git 仓库。