首页演练场案例展示应用文档博客
    • English英语
      EN
    • русский俄语
      RU
    • 日本語日语
      JA
    • français法语
      FR
    • 한국어韩语
      KO
    • 中文中文
      ZH
    • español西班牙语
      ES
    • Deutsch德语
      DE
    • العربية阿拉伯语
      AR
    • italiano意大利语
      IT
    • British English英国英语
      EN-GB
    • português葡萄牙语
      PT
    • हिन्दी印地语
      HI
    • Türkçe土耳其语
      TR
    • polski波兰语
      PL
    • Indonesia印度尼西亚语
      ID
    • Tiếng Việt越南语
      VI
    • українська乌克兰语
      UK
    /
    按框架筛选文档
    Alt+←
    为什么Intlayer?
    开始
    概念
    • Intlayer如何工作
    • 配置
    • TestFillBuildWatchExtractLoginPushPullConfigurationListVersionEditorLiveDebugDoc ReviewDoc TranslateSDK
    • 可视化编辑器
    • CMS
    • CI/CD集成
    • 翻译复数枚举条件性别插入文件嵌套MarkdownHTML函数获取
    • 每个语言环境的文件
    • 编译器
    • 自动填充
    • 测试
    • 打包优化
    环境
    • Next.js 14和应用路由器
      Next.js 15
      Next.js 无 locale URL
      Next.js和页面路由器
      编译器
    • Tanstack Start Solid
    • Astro和React
      Astro和Svelte
      Astro和Vue
      Astro和Solid
      Astro和Preact
      Astro和Lit
      Astro和Vanilla JS
    • React Router v7
      React Router v7 (fs-routes)
      Compiler
    • Nuxt和Vue
    • Vite和Solid
    • SvelteKit
    • Vite和Preact
    • Vite和Vanilla JS
    • Vite和Lit
    • Angular 19 (Webpack)
      Analog
    • React CRA
    • React Native和Expo
    • Express.js
      NestJS
      Fastify
      Hono
      Adonis
    • Lynx和React
    Plugins
    • JSON
    • gettext (.po)
    VS Code扩展
    代理
    • MCP服务器
    • 代理技能
    发布
    • v8
    • v7
    • v6
    基准测试
    • Next.js
    • TanStack
    • Vue
    • Solid
    • Svelte
    博客
    问问题
    1. Documentation
    2. 环境
    3. Vite和Preact
    Creation:2025-04-18Last update:2026-05-06
    在 GitHub 上查看应用程序模板

    此页面有可用的应用程序模板。

    查看展示应用

    此页面链接到模板的在线演示。

    将此文档参考到您的 AI 助手
    ChatGPT
    Claude
    DeepSeek
    Google AI mode
    Gemini
    Perplexity
    Mistral
    Grok

    使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商

    版本历史

    1. "更新 Solid useIntlayer API 用法以直接访问属性"
      v8.9.02026/5/4
    2. "添加 init 命令"
      v7.5.92025/12/30
    3. "初始化历史"
      v5.5.102025/6/29

    此页面的内容已使用 AI 翻译。

    查看英文原文的最新版本
    编辑此文档

    如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。

    文档的 GitHub 链接
    Copy

    复制文档 Markdown 到剪贴板

    使用 Intlayer 翻译您的 Vite 和 Preact 网站 | 国际化 (i18n)

    www.youtube.com
    ide.intlayer.org
    intlayer-vite-preact-template.vercel.app

    目录

    什么是 Intlayer?

    Intlayer 是一个创新的开源国际化 (i18n) 库,旨在简化现代 Web 应用程序的多语言支持。

    使用 Intlayer,您可以:

    • 轻松管理翻译:使用组件级的声明式字典。
    • 动态本地化元数据、路由和内容。
    • 确保 TypeScript 支持:通过自动生成的类型,改进自动补全和错误检测。
    • 受益于高级功能:例如动态语言环境检测和切换。

    在 Vite 和 Preact 应用程序中设置 Intlayer 的分步指南

    请参阅 GitHub 上的 应用程序模板。

    第 1 步:安装依赖项

    使用 npm 安装必要的包:

    bash
    复制代码

    复制代码到剪贴板

    npm install intlayer preact-intlayernpm install vite-intlayer --save-devnpx intlayer init
    • intlayer

      提供配置管理、翻译、内容声明、编译和 CLI 命令 的核心包。

    • preact-intlayer

      将 Intlayer 与 Preact 应用程序集成的包。它为 Preact 国际化提供上下文提供者和钩子。

    • vite-intlayer

      包含用于将 Intlayer 与 Vite 打包器 集成的 Vite 插件,以及用于检测用户首选语言环境、管理 cookie 和处理 URL 重定向的中间件。

    第 2 步:配置项目

    创建一个配置文件来配置应用程序的语言:

    intlayer.config.ts
    复制代码

    复制代码到剪贴板

    import { Locales, type IntlayerConfig } from "intlayer";
    
    const config: IntlayerConfig = {
      internationalization: {
        locales: [
          Locales.ENGLISH,
          Locales.FRENCH,
          Locales.SPANISH,
          // 您的其他语言环境
        ],
        defaultLocale: Locales.ENGLISH,
      },
      routing: {
        mode: "prefix-no-default", // 默认:除默认语言环境外,为所有语言环境添加前缀
        storage: ["cookie", "header"], // 默认:在 cookie 中存储语言环境并从 header 中检测
      },
    };
    
    export default config;
    通过此配置文件,您可以设置本地化 URL、路由模式、存储选项、cookie 名称、内容声明的位置和扩展名、禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表,请参阅 配置文档。

    第 3 步:在 Vite 配置中集成 Intlayer

    将 intlayer 插件添加到您的配置中。

    vite.config.ts
    复制代码

    复制代码到剪贴板

    import { defineConfig } from "vite";
    import preact from "@preact/preset-vite";
    import { intlayer } from "vite-intlayer";
    
    // https://vitejs.dev/config/
    export default defineConfig({
      plugins: [preact(), intlayer()],
    });
    intlayer() Vite 插件用于将 Intlayer 与 Vite 集成。它确保构建内容声明文件并在开发模式下监视它们。它在 Vite 应用程序中定义了 Intlayer 环境变量。此外,它还提供别名以优化性能。

    第 4 步:声明内容

    创建并管理您的内容声明以存储翻译:

    src/app.content.tsx
    复制代码

    复制代码到剪贴板

    import { t, type Dictionary } from "intlayer";
    import type { ComponentChildren } from "preact";
    
    const appContent = {
      key: "app",
      content: {
        viteLogo: t({
          en: "Vite logo",
          fr: "Logo Vite",
          es: "Logo Vite",
        }),
        preactLogo: t({
          en: "Preact logo",
          fr: "Logo Preact",
          es: "Logo Preact",
        }),
    
        title: "Vite + Preact",
    
        count: t({
          en: "count is ",
          fr: "le compte est ",
          es: "el recuento es ",
        }),
    
        edit: t<ComponentChildren>({
          en: (
            <>
              Edit <code>src/app.tsx</code> and save to test HMR
            </>
          ),
          fr: (
            <>
              Éditez <code>src/app.tsx</code> et enregistrez pour tester HMR
            </>
          ),
          es: (
            <>
              Edita <code>src/app.tsx</code> y guarda para probar HMR
            </>
          ),
        }),
    
        readTheDocs: t({
          en: "Click on the Vite and Preact logos to learn more",
          fr: "Cliquez sur les logos Vite et Preact pour en savoir plus",
          es: "Haga clic en los logotipos de Vite y Preact para obtener más información",
        }),
      },
    } satisfies Dictionary;
    
    export default appContent;
    只要您的内容声明包含在 contentDir 目录(默认情况下为 ./src)中,就可以在应用程序的任何位置定义它们。并且需匹配内容声明文件扩展名(默认情况下为 .content.{json,ts,tsx,js,jsx,mjs,cjs})。
    有关更多详细信息,请参考 内容声明文档。
    如果您的内容文件包含 TSX 代码,您可能需要导入 import { h } from "preact"; 或确保正确设置 Preact 的 JSX pragma。

    第 5 步:在代码中使用 Intlayer

    在整个应用程序中访问您的内容字典:

    src/app.tsx
    复制代码

    复制代码到剪贴板

    import { useState } from "preact/hooks";
    import type { FunctionalComponent } from "preact";
    import preactLogo from "./assets/preact.svg"; // 假设您有 preact.svg
    import viteLogo from "/vite.svg";
    import "./app.css"; // 假设您的 CSS 文件名为 app.css
    import { IntlayerProvider, useIntlayer } from "preact-intlayer";
    
    const AppContent: FunctionalComponent = () => {
      const [count, setCount] = useState(0);
      const content = useIntlayer("app");
    
      return (
        <>
          <div>
            <a href="https://vitejs.dev" target="_blank">
              <img src={viteLogo} class="logo" alt={content.viteLogo.value} />
            </a>
            <a href="https://preactjs.com" target="_blank">
              <img
                src={preactLogo}
                class="logo preact"
                alt={content.preactLogo.value}
              />
            </a>
          </div>
          <h1>{content.title}</h1>
          <div class="card">
            <button onClick={() => setCount((count) => count + 1)}>
              {content.count}
              {count}
            </button>
            <p>{content.edit}</p>
          </div>
          {/* Markdown 内容 */}
          <div>{content.myMarkdownContent}</div>
    
          {/* HTML 内容 */}
          <div>{content.myHtmlContent}</div>
    
          <p class="read-the-docs">{content.readTheDocs}</p>
        </>
      );
    };
    
    const App: FunctionalComponent = () => (
      <IntlayerProvider>
        <AppContent />
      </IntlayerProvider>
    );
    
    export default App;
    如果您想在字符串属性中使用您的内容,例如 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)}" />
    注意:在 Preact 中,className 通常写作 class。
    要了解有关 useIntlayer 钩子的更多信息,请参考 文档(preact-intlayer 的 API 类似)。
    如果您的应用程序已经存在,您可以结合使用 Intlayer 编译器 和 提取命令 在一秒钟内转换成干个组件。

    (可选)第 6 步:更改内容语言

    要更改内容的语言,您可以使用 useLocale 钩子提供的 setLocale 函数。此函数允许您设置应用程序的语言环境并相应地更新内容。

    src/components/LocaleSwitcher.tsx
    复制代码

    复制代码到剪贴板

    import type { FunctionalComponent } from "preact";
    import { Locales } from "intlayer";
    import { useLocale } from "preact-intlayer";
    
    const LocaleSwitcher: FunctionalComponent = () => {
      const { setLocale } = useLocale();
    
      return (
        <button onClick={() => setLocale(Locales.ENGLISH)}>
          Change Language to English
        </button>
      );
    };
    
    export default LocaleSwitcher;
    要了解有关 useLocale 钩子的更多信息,请参考 文档(preact-intlayer 的 API 类似)。

    (可选)步骤 7:为您的应用程序添加本地化路由

    此步骤的目的是为每种语言设置唯一的路由。这对于 SEO 和 SEO 友好的 URL 非常有用。 示例:

    plaintext
    复制代码

    复制代码到剪贴板

    - https://example.com/about- https://example.com/es/about- https://example.com/fr/about
    默认情况下,默认语言环境的路由不带前缀。如果您想为默认语言环境添加前缀,可以在配置中将 routing.mode 选项设置为 "prefix-all"。有关更多信息,请参阅 配置文档。

    要为您的应用程序添加本地化路由,您可以创建一个 LocaleRouter 组件,该组件包裹您的应用程序路由并处理基于语言环境的路由。以下是使用 preact-iso 的示例:

    src/components/LocaleRouter.tsx
    复制代码

    复制代码到剪贴板

    import { localeMap } from "intlayer";
    import { IntlayerProvider } from "preact-intlayer";
    import { LocationProvider, Router, Route } from "preact-iso";
    import type { ComponentChildren, FunctionalComponent } from "preact";
    
    /**
     * 设置特定语言环境路由的路由组件。
     * 它使用 preact-iso 管理导航并渲染本地化组件。
     */
    export const LocaleRouter: FunctionalComponent<{
      children: ComponentChildren;
    }> = ({ children }) => (
      <LocationProvider>
        <Router>
          {localeMap(({ locale, urlPrefix }) => ({ locale, urlPrefix }))
            .sort((a, b) => b.urlPrefix.length - a.urlPrefix.length)
            .map(({ locale, urlPrefix }) => (
              <Route
                key={locale}
                path={`${urlPrefix}/:rest*`}
                component={() => (
                  <IntlayerProvider locale={locale}>{children}</IntlayerProvider>
                )}
              />
            ))}
        </Router>
      </LocationProvider>
    );

    然后,您可以在应用程序中使用 LocaleRouter 组件:

    src/app.tsx
    复制代码

    复制代码到剪贴板

    import { LocaleRouter } from "./components/LocaleRouter";
    import type { FunctionalComponent } from "preact";
    
    // ... 您的 AppContent 组件
    
    const App: FunctionalComponent = () => (
      <LocaleRouter>
        <AppContent />
      </LocaleRouter>
    );
    
    export default App;

    (可选)步骤 8:在语言环境更改时更改 URL

    要在语言环境更改时更改 URL,可以使用 useLocale 钩子提供的 onLocaleChange 属性。同时,您可以使用 preact-iso 中 useLocation 的 route 方法来更新 URL 路径。

    src/components/LocaleSwitcher.tsx
    复制代码

    复制代码到剪贴板

    import { useLocation } from "preact-iso";
    import {
      Locales,
      getHTMLTextDir,
      getLocaleName,
      getLocalizedUrl,
    } from "intlayer";
    import { useLocale } from "preact-intlayer";
    import type { FunctionalComponent } from "preact";
    
    const LocaleSwitcher: FunctionalComponent = () => {
      const { url, route } = useLocation();
      const { locale, availableLocales, setLocale } = useLocale({
        onLocaleChange: (newLocale) => {
          // 使用更新后的语言环境构建 URL
          // 示例:/es/about?foo=bar
          const pathWithLocale = getLocalizedUrl(url, newLocale);
    
          // 更新 URL 路径
          route(pathWithLocale, true); // true 表示替换 (replace)
        },
      });
    
      return (
        <div>
          <button popovertarget="localePopover">{getLocaleName(locale)}</button>
          <div id="localePopover" popover="auto">
            {availableLocales.map((localeItem) => (
              <a
                href={getLocalizedUrl(url, localeItem)}
                hreflang={localeItem}
                aria-current={locale === localeItem ? "page" : undefined}
                onClick={(e) => {
                  e.preventDefault();
                  setLocale(localeItem);
                  // 设置语言环境后的程序化导航将由 onLocaleChange 处理
                }}
                key={localeItem}
              >
                <span>
                  {/* 语言环境 - 例如 FR */}
                  {localeItem}
                </span>
                <span>
                  {/* 该语言环境自身的语言名称 - 例如 Français */}
                  {getLocaleName(localeItem, localeItem)}
                </span>
                <span dir={getHTMLTextDir(localeItem)} lang={localeItem}>
                  {/* 当前语言环境下的语言名称 - 例如当当前语言环境为 Locales.SPANISH 时显示 Francés */}
                  {getLocaleName(localeItem, locale)}
                </span>
                <span dir="ltr" lang={Locales.ENGLISH}>
                  {/* 英语名称 - 例如 French */}
                  {getLocaleName(localeItem, Locales.ENGLISH)}
                </span>
              </a>
            ))}
          </div>
        </div>
      );
    };
    
    export default LocaleSwitcher;

    文档参考:

    - useLocale 钩子(preact-intlayer 的 API 类似)> - getLocaleName 钩子> - getLocalizedUrl 钩子> - getHTMLTextDir 钩子> - hreflang 属性> - lang 属性> - dir 属性> - aria-current 属性> - Popover API

    (可选)第 9 步:切换 HTML 语言和方向属性

    当您的应用程序支持多种语言时,更新 <html> 标签的 lang 和 dir 属性以匹配当前语言环境至关重要。这样做可以确保:

    • 无障碍性:屏幕阅读器和辅助技术依靠正确的 lang 属性来准确发音和解释内容。
    • 文本渲染:dir(方向)属性确保文本以正确的顺序呈现(例如,英语从左到右,阿拉伯语或希伯来语从右到左),这对于可读性至关重要。
    • SEO:搜索引擎使用 lang 属性来确定页面的语言,有助于在搜索结果中提供正确的本地化内容。

    通过在语言环境更改时动态更新这些属性,您可以确保所有支持语言的用户都能获得一致且无障碍的体验。

    实现钩子

    创建一个自定义钩子来管理 HTML 属性。该钩子监听语言环境更改并相应地更新属性:

    src/hooks/useI18nHTMLAttributes.tsx
    复制代码

    复制代码到剪贴板

    import { useEffect } from "preact/hooks";
    import { useLocale } from "preact-intlayer";
    import { getHTMLTextDir } from "intlayer";
    
    /**
     * 根据当前语言环境更新 HTML <html> 元素的 `lang` 和 `dir` 属性。
     * - `lang`: 通知浏览器和搜索引擎页面的语言。
     * - `dir`: 确保正确的阅读顺序(例如,英语为 'ltr',阿拉伯语为 'rtl')。
     *
     * 这种动态更新对于正确的文本渲染、无障碍访问和 SEO 至关重要。
     */
    export const useI18nHTMLAttributes = () => {
      const { locale } = useLocale();
    
      useEffect(() => {
        // 将语言属性更新为当前语言环境。
        document.documentElement.lang = locale;
    
        // 根据当前语言环境设置文本方向。
        document.documentElement.dir = getHTMLTextDir(locale);
      }, [locale]);
    };

    在应用程序中使用钩子

    将钩子集成到您的主组件中,以便在语言环境更改时更新 HTML 属性:

    src/app.tsx
    复制代码

    复制代码到剪贴板

    import type { FunctionalComponent } from "preact";
    import { IntlayerProvider } from "preact-intlayer"; // 如果 AppContent 需要,useIntlayer 已导入
    import { useI18nHTMLAttributes } from "./hooks/useI18nHTMLAttributes";
    import "./app.css";
    // 第 5 步中的 AppContent 定义
    
    const AppWithHooks: FunctionalComponent = () => {
      // 应用钩子以根据语言环境更新 <html> 标签的 lang 和 dir 属性。
      useI18nHTMLAttributes();
    
      // 假设 AppContent 是您在第 5 步中的主要内容显示组件
      return <AppContent />;
    };
    
    const App: FunctionalComponent = () => (
      <IntlayerProvider>
        <AppWithHooks />
      </IntlayerProvider>
    );
    
    export default App;

    (可选)第 10 步:创建本地化链接组件

    为了确保您的应用程序导航尊重当前语言环境,您可以创建一个自定义 Link 组件。此组件会自动为内部 URL 添加当前语言前缀。

    这种行为在以下几个方面非常有用:

    • SEO 和用户体验:本地化 URL 帮助搜索引擎正确索引特定语言的页面,并为用户提供其首选语言的内容。
    • 一致性:通过在整个应用程序中使用本地化链接,您可以确保导航保持在当前语言环境内,防止意外的语言切换。
    • 可维护性:将本地化逻辑集中在单个组件中可以简化 URL 的管理。

    以下是 Preact 中本地化 Link 组件的实现:

    src/components/Link.tsx
    复制代码

    复制代码到剪贴板

    import { getLocalizedUrl } from "intlayer";
    import { useLocale } from "preact-intlayer";
    import { forwardRef } from "preact/compat";
    import type { JSX } from "preact";
    
    export interface LinkProps extends JSX.HTMLAttributes<HTMLAnchorElement> {
      href: string;
    }
    
    /**
     * 检查给定 URL 是否为外部链接的实用函数。
     * 如果 URL 以 http:// 或 https:// 开头,则被视为外部链接。
     */
    export const checkIsExternalLink = (href?: string): boolean =>
      /^https?:\/\//.test(href ?? "");
    
    /**
     * 一个自定义 Link 组件,根据当前语言环境自适应 href 属性。
     * 对于内部链接,它使用 `getLocalizedUrl` 为 URL 添加语言环境前缀(例如 /fr/about)。
     * 这确保了导航保持在同一语言环境上下文中。
     */
    export const Link = forwardRef<HTMLAnchorElement, LinkProps>(
      ({ href, children, ...props }, ref) => {
        const { locale } = useLocale();
        const isExternalLink = checkIsExternalLink(href);
    
        // 如果链接是内部的且提供了有效的 href,则获取本地化 URL。
        const hrefI18n =
          href && !isExternalLink ? getLocalizedUrl(href, locale) : href;
    
        return (
          <a href={hrefI18n} ref={ref} {...props}>
            {children}
          </a>
        );
      }
    );
    
    Link.displayName = "Link";

    工作原理

    • 检测外部链接:
      辅助函数 checkIsExternalLink 确定 URL 是否为外部。外部链接保持不变,因为它们不需要本地化。
    • 检索当前语言环境:
      useLocale 钩子提供当前的语言环境(例如,法语为 fr)。
    • 本地化 URL:
      对于内部链接(即非外部链接),使用 getLocalizedUrl 自动为 URL 添加当前语言环境的前缀。这意味着如果您的用户处于法语环境,将 /about 作为 href 传递将使其转换为 /fr/about。
    • 返回链接:
      该组件返回一个带有本地化 URL 的 <a> 元素,确保导航与语言环境保持一致。

    (可选)第 11 步:渲染 Markdown 和 HTML

    Intlayer 支持在 Preact 中渲染 Markdown 和 HTML 内容。

    您可以通过使用 .use() 方法自定义 Markdown 和 HTML 内容的渲染。此方法允许您覆盖特定标签的默认渲染。

    tsx
    复制代码

    复制代码到剪贴板

    import { useIntlayer } from "preact-intlayer";const { myMarkdownContent, myHtmlContent } = useIntlayer("my-component");// ...return (  <div>    {/* 基本渲染 */}    {myMarkdownContent}    {/* Markdown 的自定义渲染 */}    {myMarkdownContent.use({      h1: (props) => <h1 style={{ color: "red" }} {...props} />,    })}    {/* HTML 的基本渲染 */}    {myHtmlContent}    {/* HTML 的自定义渲染 */}    {myHtmlContent.use({      b: (props) => <strong style={{ color: "blue" }} {...props} />,    })}  </div>);

    配置 TypeScript

    Intlayer 使用模块增强来利用 TypeScript 的优势,使您的代码库更健壮。

    自动补全

    翻译错误

    确保您的 TypeScript 配置包含自动生成的类型。

    tsconfig.json
    复制代码

    复制代码到剪贴板

    {  // ... 您现有的 TypeScript 配置  "compilerOptions": {    // ...    "jsx": "react-jsx",    "jsxImportSource": "preact", // 推荐用于 Preact 10+    // ...  },  "include": [    // ... 您现有的 TypeScript 配置    ".intlayer/**/*.ts", // 包含自动生成的类型  ],}
    确保您的 tsconfig.json 已为 Preact 设置,特别是 jsx 和 jsxImportSource;如果不使用 preset-vite 的默认值,对于较旧的 Preact 版本,还需要设置 jsxFactory/jsxFragmentFactory。

    Git 配置

    建议忽略 Intlayer 生成的文件。这样可以避免将它们提交到您的 Git 仓库。

    为此,您可以在 .gitignore 文件中添加以下指令:

    bash
    复制代码

    复制代码到剪贴板

    #  忽略 Intlayer 生成的文件.intlayer

    VS Code 扩展

    为了提升您使用 Intlayer 的开发体验,您可以安装官方的 Intlayer VS Code 扩展。

    从 VS Code 市场安装

    此扩展提供:

    • 自动补全 翻译键。
    • 实时错误检测 缺失的翻译。
    • 内联预览 翻译内容。
    • 快速操作 轻松创建和更新翻译。

    有关如何使用该扩展的更多详细信息,请参考 Intlayer VS Code 扩展文档。


    (可选) 步骤 1 : 提取组件内容

    如果您有现有的代码库,转换数千个文件可能会非常耗时。

    为了简化此过程,Intlayer 提出了 编译器 / 提取器 来转换您的组件并提取内容。

    要进行设置,您可以在 intlayer.config.ts 文件中添加 compiler 部分:

    intlayer.config.ts
    复制代码

    复制代码到剪贴板

    import { type IntlayerConfig } from "intlayer";
    
    const config: IntlayerConfig = {
      // ... 您的其他配置
      compiler: {
        /**
         * 指示是否应启用编译器。
         */
        enabled: true,
    
        /**
         * 定义输出文件路径
         */
        output: ({ fileName, extension }) => `./${fileName}${extension}`,
    
        /**
         * 指示在转换后是否应保存组件。这样,编译器只需运行一次即可转换应用程序,然后即可将其删除。
         */
        saveComponents: false,
    
        /**
         * 字典键前缀
         */
        dictionaryKeyPrefix: "",
      },
    };
    
    export default config;

    运行提取器以转换组件并提取内容

    bash
    复制代码

    复制代码到剪贴板

    npx intlayer extract

    更新您的 vite.config.ts 以包含 intlayerCompiler 插件:

    vite.config.ts
    复制代码

    复制代码到剪贴板

    import { defineConfig } from "vite";import { intlayer, intlayerCompiler } from "vite-intlayer";export default defineConfig({ plugins: [   intlayer(),   intlayerCompiler(), // 添加编译器插件 ],});
    bash
    复制代码

    复制代码到剪贴板

    npm run build # 或 npm run dev

    (可选)站点地图与 robots.txt(构建时生成)

    Intlayer 提供 generateSitemap 与 getMultilingualUrls,可将面向爬虫的多语言 sitemap.xml 和 robots.txt 格式化并自动写入 public/。实践中在 Vite 之前运行小型 Node 脚本(例如 npm 的 predev / prebuild)即可在构建或开发时生成这些文件。

    站点地图

    Intlayer 的站点地图生成会尊重你的语言配置,并包含爬虫所需的元数据。

    生成的站点地图支持 xhtml:link(hreflang)。与只列出扁平 URL 不同,Intlayer 会在各语言版本之间建立双向关联(例如 /about、/fr/about 或 /about?lang=fr,取决于路由模式)。

    Robots.txt

    使用 getMultilingualUrls,使 Disallow 覆盖敏感路径的每一种本地化写法。

    1. 在项目根目录添加 generate-seo.mjs

    generate-seo.mjs
    复制代码

    复制代码到剪贴板

    import fs from "fs";import path from "path";import { fileURLToPath } from "url";import { generateSitemap, getMultilingualUrls } from "intlayer";const __dirname = path.dirname(fileURLToPath(import.meta.url));const SITE_URL = (process.env.SITE_URL || "http://localhost:5173").replace(  /\/$/,  "");const pathList = [  { path: "/", changefreq: "daily", priority: 1.0 },  { path: "/about", changefreq: "monthly", priority: 0.7 },];const sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });fs.writeFileSync(path.join(__dirname, "public", "sitemap.xml"), sitemapXml);const getAllMultilingualUrls = (urls) =>  urls.flatMap((url) => Object.values(getMultilingualUrls(url)));const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);const robotsTxt = [  "User-agent: *",  "Allow: /",  ...disallowedPaths.map((path) => `Disallow: ${path}`),  "",  `Sitemap: ${SITE_URL}/sitemap.xml`,].join("\n");fs.writeFileSync(path.join(__dirname, "public", "robots.txt"), robotsTxt);console.log("SEO files generated successfully.");

    需已安装 intlayer 以便脚本导入。生产环境请设置环境变量 SITE_URL(例如在 CI 中)。

    建议在 Node 中使用 generate-seo.mjs(ESM)。若使用 generate-seo.js,请在 package.json 中设置 "type": "module" 或以其他方式启用 ESM。

    2. 在运行 Vite 之前执行脚本

    package.json
    复制代码

    复制代码到剪贴板

    {  "scripts": {    "dev": "vite",    "prebuild": "node generate-seo.mjs",    "build": "vite build",    "preview": "vite preview"  }}

    若使用 pnpm 或 yarn,请相应调整命令;也可在 CI 或其他步骤中调用该脚本。

    深入了解

    要进一步了解,您可以实现 可视化编辑器 或使用 CMS 将内容外部化。


    SvelteKit
    Vite和Vanilla JS
    Alt+→

    在此页面

      讨论是匿名的,并会定期审查以解决常见问题。欢迎分享功能想法、对文档的反馈或任何与 Intlayer 相关的内容, 我们会利用这些意见来制定路线图并改进产品。

      npm install intlayer preact-intlayernpm install vite-intlayer --save-devnpx intlayer init
      <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)}" />
      - https://example.com/about- https://example.com/es/about- https://example.com/fr/about
      import { useIntlayer } from "preact-intlayer";const { myMarkdownContent, myHtmlContent } = useIntlayer("my-component");// ...return (  <div>    {/* 基本渲染 */}    {myMarkdownContent}    {/* Markdown 的自定义渲染 */}    {myMarkdownContent.use({      h1: (props) => <h1 style={{ color: "red" }} {...props} />,    })}    {/* HTML 的基本渲染 */}    {myHtmlContent}    {/* HTML 的自定义渲染 */}    {myHtmlContent.use({      b: (props) => <strong style={{ color: "blue" }} {...props} />,    })}  </div>);
      {  // ... 您现有的 TypeScript 配置  "compilerOptions": {    // ...    "jsx": "react-jsx",    "jsxImportSource": "preact", // 推荐用于 Preact 10+    // ...  },  "include": [    // ... 您现有的 TypeScript 配置    ".intlayer/**/*.ts", // 包含自动生成的类型  ],}
      #  忽略 Intlayer 生成的文件.intlayer
      npx intlayer extract
      import { defineConfig } from "vite";import { intlayer, intlayerCompiler } from "vite-intlayer";export default defineConfig({ plugins: [   intlayer(),   intlayerCompiler(), // 添加编译器插件 ],});
      npm run build # 或 npm run dev
      import fs from "fs";import path from "path";import { fileURLToPath } from "url";import { generateSitemap, getMultilingualUrls } from "intlayer";const __dirname = path.dirname(fileURLToPath(import.meta.url));const SITE_URL = (process.env.SITE_URL || "http://localhost:5173").replace(  /\/$/,  "");const pathList = [  { path: "/", changefreq: "daily", priority: 1.0 },  { path: "/about", changefreq: "monthly", priority: 0.7 },];const sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });fs.writeFileSync(path.join(__dirname, "public", "sitemap.xml"), sitemapXml);const getAllMultilingualUrls = (urls) =>  urls.flatMap((url) => Object.values(getMultilingualUrls(url)));const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);const robotsTxt = [  "User-agent: *",  "Allow: /",  ...disallowedPaths.map((path) => `Disallow: ${path}`),  "",  `Sitemap: ${SITE_URL}/sitemap.xml`,].join("\n");fs.writeFileSync(path.join(__dirname, "public", "robots.txt"), robotsTxt);console.log("SEO files generated successfully.");
      {  "scripts": {    "dev": "vite",    "prebuild": "node generate-seo.mjs",    "build": "vite build",    "preview": "vite preview"  }}