首页演练场案例展示应用文档博客
    • 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和Vue
    \n\n\n```\n\n#### 在 Intlayer 中访问内容\n\nIntlayer 提供了多种 API 来访问您的内容:\n\n- **基于组件的语法**(推荐):\n 使用 `` 或 `` 语法将内容渲染为 Intlayer 节点。这与[可视化编辑器](/zh/doc/concept/editor)和[内容管理系统](/zh/doc/concept/cms)无缝集成。\n\n- **基于字符串的语法**:\n 使用 `{{ myContent }}` 将内容渲染为纯文本,不支持可视化编辑器。\n\n- **原始 HTML 语法**:\n 使用 `
    ` 来渲染内容为原始 HTML,不支持可视化编辑器。\n\n- **解构语法**:\n `useIntlayer` 组合函数返回一个包含内容的 Proxy。该 Proxy 可以被解构以访问内容,同时保持响应性。\n - 使用 `const content = useIntlayer(\"myContent\");` 并通过 `{{ content.myContent }}` / `` 访问内容。\n - 或者使用 `const { myContent } = useIntlayer(\"myContent\");` 并通过 `{{ myContent }}` / `` 解构访问内容。\n\n> 如果您的应用程序已经存在,您可以结合使用 [Intlayer 编译器](/zh/doc/compiler) 和 [提取命令](/zh/doc/concept/cli/extract) 在一秒钟内转换成干个组件。\n\n### (可选)步骤 6:更改内容语言\n\n要更改内容的语言,可以使用 `useLocale` 组合函数提供的 `setLocale` 函数。该函数允许你设置应用的语言环境,并相应地更新内容。\n\n创建一个组件以切换语言:\n\n```vue fileName=\"src/components/LocaleSwitcher.vue\"\n\n\n\n```\n\n然后,在你的 App.vue 中使用该组件:\n\n```vue fileName=\"src/App.vue\"\n\n\n\n```\n\n### (可选)步骤7:为您的应用添加本地化路由\n\n在 Vue 应用中添加本地化路由通常涉及使用带有语言前缀的 Vue Router。这为每种语言创建唯一的路由,有助于 SEO 和 SEO 友好的 URL。\n\n示例:\n\n```plaintext\n- https://example.com/about\n- https://example.com/es/about\n- https://example.com/fr/about\n```\n\n首先,安装 Vue Router:\n\n```bash packageManager=\"npm\"\nnpm install vue-router\nnpx intlayer init\n```\n\n```bash packageManager=\"pnpm\"\npnpm add vue-router\npnpm intlayer init\n```\n\n```bash packageManager=\"yarn\"\nyarn add vue-router\n```\n\n然后,创建一个处理基于语言环境路由的路由配置:\n\n```js fileName=\"src/router/index.ts\"\nimport {\n localeFlatMap,\n type Locale,\n} from 'intlayer';\nimport { createIntlayerClient } from \"vue-intlayer\";\nimport { createRouter, createWebHistory } from 'vue-router';\nimport HomeView from './views/home/HomeView.vue';\nimport RootView from './views/root/Root.vue';\n\n/**\n * 声明带有语言环境特定路径和元数据的路由。\n */\nconst routes = localeFlatMap(({ urlPrefix, locale }) => [\n {\n path: `${urlPrefix}/`,\n name: `Root-${locale}`,\n component: RootView,\n meta: {\n locale,\n },\n },\n {\n path: `${urlPrefix}/home`,\n name: `Home-${locale}`,\n component: HomeView,\n meta: {\n locale,\n },\n },\n]);\n\n// 创建路由实例\nexport const router = createRouter({\n history: createWebHistory(),\n routes,\n});\n\n// 添加导航守卫以处理语言环境\nrouter.beforeEach((to, _from, next) => {\n const client = createIntlayerClient();\n\n const metaLocale = to.meta.locale as Locale;\n\n // 重用路由元信息中定义的语言环境\n client.setLocale(metaLocale);\n next();\n});\n```\n\n> 名称用于在路由器中识别路由。它应在所有路由中唯一,以避免冲突并确保正确的导航和链接。\n\n然后,在你的 main.js 文件中注册路由器:\n\n```js fileName=\"src/main.ts\"\nimport { createApp } from \"vue\";\nimport App from \"./App.vue\";\nimport { router } from \"./router\";\nimport \"./style.css\";\n\nconst app = createApp(App);\n\n// 将路由器添加到应用中\napp.use(router);\n\n// 挂载应用\napp.mount(\"#app\");\n```\n\n然后更新你的 `App.vue` 文件以渲染 RouterView 组件。该组件将显示当前路由匹配的组件。\n\n```vue fileName=\"src/App.vue\"\n\n\n\n```\n\n同时,你也可以使用 `intlayerProxy` 为你的应用添加服务器端路由。该插件会根据 URL 自动检测当前语言环境并设置相应的语言环境 cookie。如果未指定语言环境,插件将根据用户浏览器的语言偏好确定最合适的语言环境。如果仍未检测到语言环境,则会重定向到默认语言环境。\n\n```typescript {3,7} fileName=\"vite.config.ts\" codeFormat={[\"typescript\", \"esm\", \"commonjs\"]}\nimport { defineConfig } from \"vite\";\nimport vue from \"@vitejs/plugin-vue\";\nimport { intlayer, intlayerProxy } from \"vite-intlayer\";\n\n// https://vitejs.dev/config/\nexport default defineConfig({\n plugins: [\n intlayerProxy(), // should be placed first\n vue(),\n intlayer(),\n ],\n});\n```\n\n### (可选)步骤 8:当语言环境变化时更改 URL\n\n为了在用户更改语言时自动更新 URL,您可以修改 `LocaleSwitcher` 组件以使用 Vue Router:\n\n```vue fileName=\"src/components/LocaleSwitcher.vue\"\n\n\n\n```\n\n提示:为了更好的 SEO 和可访问性,使用如 `` 这样的标签来链接到本地化页面,如步骤10所示。这允许搜索引擎正确发现和索引特定语言的 URL。为了保持 SPA 行为,可以通过 @click.prevent 阻止默认导航,使用 useLocale 更改语言环境,并通过 Vue Router 编程式导航。\n\n```html\n
      \n
    1. \n \n
      \n English\n 英语\n EN\n
      \n
      \n
    2. \n
    3. \n \n
      \n Español\n 西班牙语\n ES\n
      \n \n
    4. \n
    \n```\n\n### (可选)步骤9:切换HTML的语言和方向属性\n\n当您的应用支持多种语言时,更新``标签的`lang`和`dir`属性以匹配当前语言环境至关重要。这样做可以确保:\n\n- **无障碍访问**:屏幕阅读器和辅助技术依赖正确的 `lang` 属性来准确发音和解释内容。\n- **文本渲染**:`dir`(方向)属性确保文本以正确的顺序呈现(例如,英语为从左到右,阿拉伯语或希伯来语为从右到左),这对于可读性至关重要。\n- **搜索引擎优化(SEO)**:搜索引擎使用 `lang` 属性来确定页面的语言,有助于在搜索结果中提供正确的本地化内容。\n\n通过在语言环境变化时动态更新这些属性,您可以确保所有支持语言的用户都获得一致且无障碍的体验。\n\n```js fileName=\"src/composables/useI18nHTMLAttributes.ts\"\nimport { watch } from \"vue\";\nimport { useLocale } from \"vue-intlayer\";\nimport { getHTMLTextDir } from \"intlayer\";\n\n/**\n * 组合函数,根据当前语言环境更新 HTML 元素的 `lang` 和 `dir` 属性。\n *\n * @example\n * // 在你的 App.vue 或全局组件中\n * import { useI18nHTMLAttributes } from './composables/useI18nHTMLAttributes'\n *\n * useI18nHTMLAttributes()\n */\nexport const useI18nHTMLAttributes = () => {\n const { locale } = useLocale();\n\n // 每当语言环境变化时更新 HTML 属性\n watch(\n () => locale.value,\n (newLocale) => {\n if (!newLocale) return;\n\n // 更新语言属性\n document.documentElement.lang = newLocale;\n\n // 设置文本方向(大多数语言为从左到右,阿拉伯语、希伯来语等为从右到左)\n document.documentElement.dir = getHTMLTextDir(newLocale);\n },\n { immediate: true }\n );\n};\n```\n\n在你的 `App.vue` 或全局组件中使用此组合函数:\n\n```vue fileName=\"src/App.vue\"\n\n\n\n```\n\n### (可选)步骤 10:创建本地化链接组件\n\n为了确保您的应用程序导航遵循当前的语言环境,您可以创建一个自定义的 `Link` 组件。该组件会自动在内部 URL 前添加当前语言的前缀。例如,当讲法语的用户点击“关于”页面的链接时,他们会被重定向到 `/fr/about`,而不是 `/about`。\n\n这种行为有几个好处:\n\n- **SEO 和用户体验**:本地化的 URL 有助于搜索引擎正确索引特定语言的页面,并为用户提供其偏好的语言内容。\n- **一致性**:通过在整个应用中使用本地化链接,您可以确保导航保持在当前语言环境内,避免意外的语言切换。\n- **可维护性**:将本地化逻辑集中在单个组件中简化了 URL 的管理,使您的代码库更易于维护和扩展,随着应用程序的增长。\n\n```vue fileName=\"src/components/Link.vue\"\n\n\n\n```\n\n用于 Vue Router,创建一个路由专用版本:\n\n```vue fileName=\"src/components/RouterLink.vue\"\n\n\n\n```\n\n在您的应用程序中使用这些组件:\n\n```vue fileName=\"src/App.vue\"\n\n\n\n```\n\n### (可选)步骤 11:渲染 Markdown\n\nIntlayer 支持在您的 Vue 应用中直接渲染 Markdown 内容。默认情况下,Markdown 被视为纯文本。要将 Markdown 转换为丰富的 HTML,您可以集成一个 Markdown 解析器 [markdown-it](https://github.com/markdown-it/markdown-it)。\n\n当您的翻译内容包含格式化内容,如列表、链接或强调时,这尤其有用。\n\n默认情况下,Intlayer 将 Markdown 渲染为字符串。但 Intlayer 也提供了一种使用 `installIntlayerMarkdown` 函数将 Markdown 渲染为 HTML 的方式。\n\n> 要了解如何使用 `intlayer` 包声明 Markdown 内容,请参见 [markdown 文档](https://github.com/aymericzip/intlayer/tree/main/docs/zh/dictionary/markdown.md)。\n\n```ts fileName=\"main.ts\"\nimport MarkdownIt from \"markdown-it\";\nimport { createApp, h } from \"vue\";\nimport { installIntlayer, installIntlayerMarkdown } from \"vue-intlayer\";\n\nconst app = createApp(App);\n\napp.use(intlayer);\n\nconst md = new MarkdownIt({\n html: true, // 允许 HTML 标签\n linkify: true, // 自动识别链接\n typographer: true, // 启用智能引号、破折号等排版功能\n});\n\n// 告诉 Intlayer 在需要将 markdown 转换为 HTML 时使用 md.render()\ninstallIntlayerMarkdown(app, (markdown) => {\n const html = md.render(markdown);\n return h(\"div\", { innerHTML: html });\n});\n```\n\n注册完成后,您可以使用基于组件的语法直接显示 Markdown 内容:\n\n```vue\n\n\n\n```\n\n### 配置 TypeScript\n\nIntlayer 使用模块增强来利用 TypeScript 的优势,使您的代码库更强大。\n\n![Autocompletion](https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true)\n\n![Translation error](https://github.com/aymericzip/intlayer/blob/main/docs/assets/translation_error.png?raw=true)\n\n确保您的 TypeScript 配置包含自动生成的类型。\n\n```json5 fileName=\"tsconfig.json\"\n{\n // ... 您现有的 TypeScript 配置\n \"include\": [\n // ... 您现有的 TypeScript 配置\n \".intlayer/**/*.ts\", // 包含自动生成的类型\n ],\n}\n```\n\n### Git 配置\n\n建议忽略 Intlayer 生成的文件。这样可以避免将它们提交到您的 Git 仓库中。\n\n为此,您可以在 `.gitignore` 文件中添加以下指令:\n\n```bash\n# 忽略 Intlayer 生成的文件\n.intlayer\n```\n\n### VS Code 扩展\n\n为了提升您使用 Intlayer 的开发体验,您可以安装官方的 **Intlayer VS Code 扩展**。\n\n[从 VS Code 市场安装](https://marketplace.visualstudio.com/items?itemName=intlayer.intlayer-vs-code-extension)\n\n该扩展提供:\n\n- 翻译键的 **自动补全**。\n- 缺失翻译的 **实时错误检测**。\n- 翻译内容的 **内联预览**。\n- 轻松创建和更新翻译的 **快速操作**。\n\n建议忽略由 Intlayer 生成的文件。这样可以避免将它们提交到您的 Git 仓库中。\n\n为此,您可以在 `.gitignore` 文件中添加以下指令:\n\n```bash\n# 忽略由 Intlayer 生成的文件\n.intlayer\n```\n\n### VS Code 扩展\n\n为了提升您使用 Intlayer 的开发体验,您可以安装官方的 **Intlayer VS Code 扩展**。\n\n[从 VS Code 市场安装](https://marketplace.visualstudio.com/items?itemName=intlayer.intlayer-vs-code-extension)\n\n该扩展提供:\n\n- 翻译键的 **自动补全**。\n- 缺失翻译的 **实时错误检测**。\n- 翻译内容的 **内联预览**。\n- 轻松创建和更新翻译的 **快速操作**。\n\n有关如何使用该扩展的更多详细信息,请参阅 [Intlayer VS Code 扩展文档](https://intlayer.org/doc/vs-code-extension)。\n\n---\n\n### (可选) 步骤 1 : 提取组件内容\n\n如果您有现有的代码库,转换数千个文件可能会非常耗时。\n\n为了简化此过程,Intlayer 提出了 [编译器](/zh/doc/compiler) / [提取器](/zh/doc/concept/cli/extract) 来转换您的组件并提取内容。\n\n要进行设置,您可以在 `intlayer.config.ts` 文件中添加 `compiler` 部分:\n\n```typescript fileName=\"intlayer.config.ts\" codeFormat={[\"typescript\", \"esm\", \"commonjs\"]}\nimport { type IntlayerConfig } from \"intlayer\";\n\nconst config: IntlayerConfig = {\n // ... 您的其他配置\n compiler: {\n /**\n * 指示是否应启用编译器。\n */\n enabled: true,\n\n /**\n * 定义输出文件路径\n */\n output: ({ fileName, extension }) => `./${fileName}${extension}`,\n\n /**\n * 指示在转换后是否应保存组件。这样,编译器只需运行一次即可转换应用程序,然后即可将其删除。\n */\n saveComponents: false,\n\n /**\n * 字典键前缀\n */\n dictionaryKeyPrefix: \"\",\n },\n};\n\nexport default config;\n```\n\n\n \n\n运行提取器以转换组件并提取内容\n\n```bash packageManager=\"npm\"\nnpx intlayer extract\n```\n\n```bash packageManager=\"pnpm\"\npnpm intlayer extract\n```\n\n```bash packageManager=\"yarn\"\nyarn intlayer extract\n```\n\n```bash packageManager=\"bun\"\nbun x intlayer extract\n```\n\n \n \n\n更新您的 `vite.config.ts` 以包含 `intlayerCompiler` 插件:\n\n```ts fileName=\"vite.config.ts\"\nimport { defineConfig } from \"vite\";\nimport { intlayer, intlayerCompiler } from \"vite-intlayer\";\n\nexport default defineConfig({\n plugins: [\n intlayer(),\n intlayerCompiler(), // 添加编译器插件\n ],\n});\n```\n\n```bash packageManager=\"npm\"\nnpm run build # 或 npm run dev\n```\n\n```bash packageManager=\"pnpm\"\npnpm run build # 或 pnpm run dev\n```\n\n```bash packageManager=\"yarn\"\nyarn build # 或 yarn dev\n```\n\n```bash packageManager=\"bun\"\nbun run build # Or bun run dev\n```\n\n \n\n\n### (可选)站点地图与 robots.txt(构建时生成)\n\nIntlayer 提供 `generateSitemap` 与 `getMultilingualUrls`,可将面向爬虫的多语言 `sitemap.xml` 和 `robots.txt` 格式化并自动写入 `public/`。实践中在 Vite **之前**运行小型 Node 脚本(例如 npm 的 `predev` / `prebuild`)即可在构建或开发时生成这些文件。\n\n#### 站点地图\n\nIntlayer 的站点地图生成会尊重你的语言配置,并包含爬虫所需的元数据。\n\n> 生成的站点地图支持 `xhtml:link`(hreflang)。与只列出扁平 URL 不同,Intlayer 会在各语言版本之间建立双向关联(例如 `/about`、`/fr/about` 或 `/about?lang=fr`,取决于路由模式)。\n\n#### Robots.txt\n\n使用 `getMultilingualUrls`,使 `Disallow` 覆盖敏感路径的每一种本地化写法。\n\n#### 1. 在项目根目录添加 `generate-seo.mjs`\n\n```javascript fileName=\"generate-seo.mjs\"\nimport fs from \"fs\";\nimport path from \"path\";\nimport { fileURLToPath } from \"url\";\nimport { generateSitemap, getMultilingualUrls } from \"intlayer\";\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\n\nconst SITE_URL = (process.env.SITE_URL || \"http://localhost:5173\").replace(\n /\\/$/,\n \"\"\n);\n\nconst pathList = [\n { path: \"/\", changefreq: \"daily\", priority: 1.0 },\n { path: \"/about\", changefreq: \"monthly\", priority: 0.7 },\n];\n\nconst sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });\nfs.writeFileSync(path.join(__dirname, \"public\", \"sitemap.xml\"), sitemapXml);\n\nconst getAllMultilingualUrls = (urls) =>\n urls.flatMap((url) => Object.values(getMultilingualUrls(url)));\n\nconst disallowedPaths = getAllMultilingualUrls([\"/admin\", \"/private\"]);\n\nconst robotsTxt = [\n \"User-agent: *\",\n \"Allow: /\",\n ...disallowedPaths.map((path) => `Disallow: ${path}`),\n \"\",\n `Sitemap: ${SITE_URL}/sitemap.xml`,\n].join(\"\\n\");\n\nfs.writeFileSync(path.join(__dirname, \"public\", \"robots.txt\"), robotsTxt);\n\nconsole.log(\"SEO files generated successfully.\");\n```\n\n需已安装 `intlayer` 以便脚本导入。生产环境请设置环境变量 `SITE_URL`(例如在 CI 中)。\n\n> 建议在 Node 中使用 `generate-seo.mjs`(ESM)。若使用 `generate-seo.js`,请在 `package.json` 中设置 `\"type\": \"module\"` 或以其他方式启用 ESM。\n\n#### 2. 在运行 Vite 之前执行脚本\n\n```json fileName=\"package.json\"\n{\n \"scripts\": {\n \"dev\": \"vite\",\n \"prebuild\": \"node generate-seo.mjs\",\n \"build\": \"vite build\",\n \"preview\": \"vite preview\"\n }\n}\n```\n\n若使用 pnpm 或 yarn,请相应调整命令;也可在 CI 或其他步骤中调用该脚本。\n\n### 深入了解\n\n要进一步使用,您可以实现 [可视化编辑器](/zh/doc/concept/editor) 或使用 [CMS](/zh/doc/concept/cms) 来外部管理您的内容。\n\n---\n","about":"了解如何使您的 Vite 和 Vue 网站支持多语言。按照文档进行国际化(i18n)和翻译。","url":"https://intlayer.org/zh/doc/environment/vite-and-vue","datePublished":"18-04-2025","dateModified":"06-05-2026","keywords":"国际化, 文档, Intlayer, Vite, Vue, JavaScript","license":"https://raw.githubusercontent.com/aymericzip/intlayer/refs/heads/main/LICENSE","audience":{"@type":"Audience","audienceType":"开发者,内容经理"}}
    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 and Vue | 国际化(i18n)

    请参阅 GitHub 上的应用模板。

    什么是 Intlayer?

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

    使用 Intlayer,您可以:

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

    在 Vite 和 Vue 应用中设置 Intlayer 的分步指南

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

    请参阅 GitHub 上的应用模板。

    第一步:安装依赖

    使用 npm 安装所需的包:

    bash
    复制代码

    复制代码到剪贴板

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

      核心包,提供国际化工具,用于配置管理、翻译、内容声明、转译以及命令行工具。

    • vue-intlayer 将 Intlayer 集成到 Vue 应用中的包,提供 Vue 国际化的上下文提供者和组合式函数。

    • 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,
      },
    };
    
    export default config;
    通过此配置文件,您可以设置本地化的 URL、中间件重定向、cookie 名称、内容声明的位置和扩展名,禁用控制台中的 Intlayer 日志等。有关可用参数的完整列表,请参阅配置文档。

    第三步:在您的 Vite 配置中集成 Intlayer

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

    vite.config.ts
    复制代码

    复制代码到剪贴板

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

    第4步:声明您的内容

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

    src/helloWorld.content.ts
    复制代码

    复制代码到剪贴板

    import { t, type Dictionary } from "intlayer";
    
    const helloWorldContent = {
      key: "helloworld",
      content: {
        count: t({ en: "count is ", fr: "le compte est ", es: "el recuento es " }),
        edit: t({
          en: "Edit <code>components/HelloWorld.vue</code> and save to test HMR",
          fr: "Éditez <code>components/HelloWorld.vue</code> et enregistrez pour tester HMR",
          es: "Edita <code>components/HelloWorld.vue</code> y guarda para probar HMR",
        }),
        checkOut: t({ en: "Check out ", fr: "Vérifiez ", es: "Compruebe " }),
        officialStarter: t({
          en: ", the official Vue + Vite starter",
          fr: ", le starter officiel Vue + Vite",
          es: ", el starter oficial Vue + Vite",
        }),
        learnMore: t({
          zh: "了解更多关于 Vue 的 IDE 支持,详见 ",
          en: "Learn more about IDE Support for Vue in the ",
          fr: "En savoir plus sur le support IDE pour Vue dans le ",
          es: "Aprenda más sobre el soporte IDE para Vue en el ",
        }),
        vueDocs: t({
          zh: "Vue 文档扩展指南",
          en: "Vue Docs Scaling up Guide",
          fr: "Vue Docs Scaling up Guide",
          es: "Vue Docs Scaling up Guide",
        }),
        readTheDocs: t({
          en: "Click on the Vite and Vue logos to learn more",
          fr: "Cliquez sur les logos Vite et Vue pour en savoir plus",
          es: "Haga clic en los logotipos de Vite y Vue para obtener más información",
          zh: "点击 Vite 和 Vue 标志以了解更多信息",
        }),
      },
    } satisfies Dictionary;
    
    export default helloWorldContent;
    您的内容声明可以定义在应用程序中的任何位置,只要它们被包含在 contentDir 目录中(默认是 ./src)。并且文件扩展名需匹配内容声明的文件扩展名(默认是 .content.{json,ts,tsx,js,jsx,mjs,cjs})。
    更多详情,请参阅内容声明文档。

    第5步:在代码中使用 Intlayer

    要在整个 Vue 应用中使用 Intlayer 的国际化功能,首先需要在主文件中注册 Intlayer 单例实例。这一步非常关键,因为它为应用中的所有组件提供了国际化上下文,使得翻译内容可以在组件树中的任何位置访问。

    复制代码

    复制代码到剪贴板

    import { createApp } from "vue";import { intlayer } from "vue-intlayer";import App from "./App.vue";import "./style.css";const app = createApp(App);// 在顶层注入提供者app.use(intlayer);// 挂载应用app.mount("#app");

    通过创建主 Vue 组件并使用 useIntlayer 组合函数,可以在整个应用中访问内容字典:

    src/HelloWord.vue
    复制代码

    复制代码到剪贴板

    <script setup lang="ts">import { ref } from "vue";import { useIntlayer } from "vue-intlayer";defineProps({  msg: String,});const {  count,  edit,  checkOut,  officialStarter,  learnMore,  vueDocs,  readTheDocs,} = useIntlayer("helloworld");const countRef = ref(0);</script><template>  <h1>{{ msg }}</h1>  <div class="card">    <button type="button" @click="countRef++">      <count />      {{ countRef }}    </button>    <p v-html="edit"></p>  </div>  <p>    <checkOut />    <a href="https://vuejs.org/guide/quick-start.html#local" target="_blank"      >create-vue</a    >,<officialStarter />  </p>  <p>    <learnMore />    <a      href="https://vuejs.org/guide/scaling-up/tooling.html#ide-support"      target="_blank"      ><vueDocs /></a    >.  </p>  <p class="read-the-docs"><readTheDocs /></p>  <p class="read-the-docs">{{ readTheDocs }}</p></template>

    在 Intlayer 中访问内容

    Intlayer 提供了多种 API 来访问您的内容:

    • 基于组件的语法(推荐): 使用 <myContent /> 或 <Component :is="myContent" /> 语法将内容渲染为 Intlayer 节点。这与可视化编辑器和内容管理系统无缝集成。

    • 基于字符串的语法: 使用 {{ myContent }} 将内容渲染为纯文本,不支持可视化编辑器。

    • 原始 HTML 语法: 使用 <div v-html="myContent" /> 来渲染内容为原始 HTML,不支持可视化编辑器。

    • 解构语法: useIntlayer 组合函数返回一个包含内容的 Proxy。该 Proxy 可以被解构以访问内容,同时保持响应性。

      • 使用 const content = useIntlayer("myContent"); 并通过 {{ content.myContent }} / <content.myContent /> 访问内容。
      • 或者使用 const { myContent } = useIntlayer("myContent"); 并通过 {{ myContent }} / <myContent/> 解构访问内容。
    如果您的应用程序已经存在,您可以结合使用 Intlayer 编译器 和 提取命令 在一秒钟内转换成干个组件。

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

    要更改内容的语言,可以使用 useLocale 组合函数提供的 setLocale 函数。该函数允许你设置应用的语言环境,并相应地更新内容。

    创建一个组件以切换语言:

    src/components/LocaleSwitcher.vue
    复制代码

    复制代码到剪贴板

    <template>  <div class="locale-switcher">    <select v-model="selectedLocale" @change="changeLocale">      <option v-for="loc in availableLocales" :key="loc" :value="loc">        {{ getLocaleName(loc) }}      </option>    </select>  </div></template><script setup lang="ts">import { ref, watch } from "vue";import { getLocaleName } from "intlayer";import { useLocale } from "vue-intlayer";// 获取语言信息和 setLocale 函数const { locale, availableLocales, setLocale } = useLocale();// 使用 ref 跟踪选中的语言const selectedLocale = ref(locale.value);// 当选择更改时更新语言const changeLocale = () => setLocale(selectedLocale.value);// 保持 selectedLocale 与全局 locale 同步watch(  () => locale.value,  (newLocale) => {    selectedLocale.value = newLocale;  });</script>

    然后,在你的 App.vue 中使用该组件:

    src/App.vue
    复制代码

    复制代码到剪贴板

    <script setup lang="ts">import { useIntlayer } from "vue-intlayer";import HelloWorld from "@components/HelloWorld.vue";import LocaleSwitcher from "@components/LocaleSwitcher.vue";import { ref, watch } from "vue";const content = useIntlayer("app"); // 创建相关的 intlayer 声明文件</script><template>  <div>    <LocaleSwitcher />    <a href="https://vite.dev" target="_blank">      <img src="/vite.svg" class="logo" :alt="content.viteLogo" />    </a>    <a href="https://vuejs.org/" target="_blank">      <img src="./assets/vue.svg" class="logo vue" :alt="content.vueLogo" />    </a>  </div>  <HelloWorld :msg="content.title" /></template>

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

    在 Vue 应用中添加本地化路由通常涉及使用带有语言前缀的 Vue Router。这为每种语言创建唯一的路由,有助于 SEO 和 SEO 友好的 URL。

    示例:

    plaintext
    复制代码

    复制代码到剪贴板

    - https://example.com/about- https://example.com/es/about- https://example.com/fr/about

    首先,安装 Vue Router:

    bash
    复制代码

    复制代码到剪贴板

    npm install vue-routernpx intlayer init

    然后,创建一个处理基于语言环境路由的路由配置:

    src/router/index.ts
    复制代码

    复制代码到剪贴板

    import {  localeFlatMap,  type Locale,} from 'intlayer';import { createIntlayerClient } from "vue-intlayer";import { createRouter, createWebHistory } from 'vue-router';import HomeView from './views/home/HomeView.vue';import RootView from './views/root/Root.vue';/** * 声明带有语言环境特定路径和元数据的路由。 */const routes = localeFlatMap(({ urlPrefix, locale }) => [  {    path: `${urlPrefix}/`,    name: `Root-${locale}`,    component: RootView,    meta: {      locale,    },  },  {    path: `${urlPrefix}/home`,    name: `Home-${locale}`,    component: HomeView,    meta: {      locale,    },  },]);// 创建路由实例export const router = createRouter({  history: createWebHistory(),  routes,});// 添加导航守卫以处理语言环境router.beforeEach((to, _from, next) => {  const client = createIntlayerClient();  const metaLocale = to.meta.locale as Locale;  // 重用路由元信息中定义的语言环境  client.setLocale(metaLocale);  next();});
    名称用于在路由器中识别路由。它应在所有路由中唯一,以避免冲突并确保正确的导航和链接。

    然后,在你的 main.js 文件中注册路由器:

    src/main.ts
    复制代码

    复制代码到剪贴板

    import { createApp } from "vue";import App from "./App.vue";import { router } from "./router";import "./style.css";const app = createApp(App);// 将路由器添加到应用中app.use(router);// 挂载应用app.mount("#app");

    然后更新你的 App.vue 文件以渲染 RouterView 组件。该组件将显示当前路由匹配的组件。

    src/App.vue
    复制代码

    复制代码到剪贴板

    <script setup lang="ts">import LocaleSwitcher from "@components/LocaleSwitcher.vue";</script><template>  <nav>    <LocaleSwitcher />  </nav>  <RouterView /></template>

    同时,你也可以使用 intlayerProxy 为你的应用添加服务器端路由。该插件会根据 URL 自动检测当前语言环境并设置相应的语言环境 cookie。如果未指定语言环境,插件将根据用户浏览器的语言偏好确定最合适的语言环境。如果仍未检测到语言环境,则会重定向到默认语言环境。

    vite.config.ts
    复制代码

    复制代码到剪贴板

    import { defineConfig } from "vite";
    import vue from "@vitejs/plugin-vue";
    import { intlayer, intlayerProxy } from "vite-intlayer";
    
    // https://vitejs.dev/config/
    export default defineConfig({
      plugins: [
        intlayerProxy(), // should be placed first
        vue(),
        intlayer(),
      ],
    });

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

    为了在用户更改语言时自动更新 URL,您可以修改 LocaleSwitcher 组件以使用 Vue Router:

    src/components/LocaleSwitcher.vue
    复制代码

    复制代码到剪贴板

    <template>  <div class="locale-switcher">    <select v-model="selectedLocale" @change="changeLocale">      <option v-for="loc in availableLocales" :key="loc" :value="loc">        {{ getLocaleName(loc) }}      </option>    </select>  </div></template><script setup lang="ts">import { ref, watch } from "vue";import { useRouter } from "vue-router";import { Locales, getLocaleName, getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";// 获取 Vue Router 实例const router = useRouter();// 获取语言信息和设置语言的函数const { locale, availableLocales, setLocale } = useLocale({  onLocaleChange: (newLocale) => {    // 获取当前路由并创建本地化的 URL    const currentPath = router.currentRoute.value.fullPath;    const localizedPath = getLocalizedUrl(currentPath, newLocale);    // 导航到本地化路由而不重新加载页面    router.push(localizedPath);  },});// 使用 ref 跟踪选中的语言const selectedLocale = ref(locale.value);// 当选择更改时更新语言环境const changeLocale = () => {  setLocale(selectedLocale.value);};// 保持 selectedLocale 与全局语言环境同步watch(  () => locale.value,  (newLocale) => {    selectedLocale.value = newLocale;  });</script>

    提示:为了更好的 SEO 和可访问性,使用如 <a href="/fr/home" hreflang="fr"> 这样的标签来链接到本地化页面,如步骤10所示。这允许搜索引擎正确发现和索引特定语言的 URL。为了保持 SPA 行为,可以通过 @click.prevent 阻止默认导航,使用 useLocale 更改语言环境,并通过 Vue Router 编程式导航。

    html
    复制代码

    复制代码到剪贴板

    <ol>  <li>    <a      hreflang="x-default"      aria-label="切换到英语"      target="_self"      aria-current="page"      href="/doc/get-started"    >      <div>        <span dir="ltr" lang="en">English</span>        <span>英语</span>        <span>EN</span>      </div>    </a>  </li>  <li>    <a      hreflang="es"      aria-label="切换到西班牙语"      target="_self"      href="/es/doc/get-started"    >      <div>        <span dir="ltr" lang="es">Español</span>        <span>西班牙语</span>        <span>ES</span>      </div>    </a>  </li></ol>

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

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

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

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

    src/composables/useI18nHTMLAttributes.ts
    复制代码

    复制代码到剪贴板

    import { watch } from "vue";import { useLocale } from "vue-intlayer";import { getHTMLTextDir } from "intlayer";/** * 组合函数,根据当前语言环境更新 HTML <html> 元素的 `lang` 和 `dir` 属性。 * * @example * // 在你的 App.vue 或全局组件中 * import { useI18nHTMLAttributes } from './composables/useI18nHTMLAttributes' * * useI18nHTMLAttributes() */export const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  // 每当语言环境变化时更新 HTML 属性  watch(    () => locale.value,    (newLocale) => {      if (!newLocale) return;      // 更新语言属性      document.documentElement.lang = newLocale;      // 设置文本方向(大多数语言为从左到右,阿拉伯语、希伯来语等为从右到左)      document.documentElement.dir = getHTMLTextDir(newLocale);    },    { immediate: true }  );};

    在你的 App.vue 或全局组件中使用此组合函数:

    src/App.vue
    复制代码

    复制代码到剪贴板

    <script setup lang="ts">import { useI18nHTMLAttributes } from "@composables/useI18nHTMLAttributes";// 根据当前语言环境应用 HTML 属性useI18nHTMLAttributes();</script><template>  <!-- 你的应用模板 --></template>

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

    为了确保您的应用程序导航遵循当前的语言环境,您可以创建一个自定义的 Link 组件。该组件会自动在内部 URL 前添加当前语言的前缀。例如,当讲法语的用户点击“关于”页面的链接时,他们会被重定向到 /fr/about,而不是 /about。

    这种行为有几个好处:

    • SEO 和用户体验:本地化的 URL 有助于搜索引擎正确索引特定语言的页面,并为用户提供其偏好的语言内容。
    • 一致性:通过在整个应用中使用本地化链接,您可以确保导航保持在当前语言环境内,避免意外的语言切换。
    • 可维护性:将本地化逻辑集中在单个组件中简化了 URL 的管理,使您的代码库更易于维护和扩展,随着应用程序的增长。
    src/components/Link.vue
    复制代码

    复制代码到剪贴板

    <template>  <a :href="localizedHref" v-bind="$attrs">    <slot />  </a></template><script setup lang="ts">import { computed } from "vue";import { getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";const props = defineProps({  href: {    type: String,    required: true,  },});const { locale } = useLocale();// 检查链接是否为外部链接const isExternalLink = computed(() => /^https?:\/\//.test(props.href || ""));// 为内部链接创建本地化的 hrefconst localizedHref = computed(() =>  isExternalLink.value ? props.href : getLocalizedUrl(props.href, locale.value));</script>

    用于 Vue Router,创建一个路由专用版本:

    src/components/RouterLink.vue
    复制代码

    复制代码到剪贴板

    <template>  <router-link :to="localizedTo" v-bind="$attrs">    <slot />  </router-link></template><script setup lang="ts">import { computed } from "vue";import { getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";const props = defineProps({  to: {    type: [String, Object],    required: true,  },});const { locale } = useLocale();// 为 router-link 创建本地化的 to 属性const localizedTo = computed(() => {  if (typeof props.to === "string") {    return getLocalizedUrl(props.to, locale.value);  } else {    // 如果 'to' 是一个对象,则本地化 path 属性    return {      ...props.to,      path: getLocalizedUrl(props.to.path ?? "/", locale.value),    };  }});</script>

    在您的应用程序中使用这些组件:

    src/App.vue
    复制代码

    复制代码到剪贴板

    <template>  <div>    <!-- Vue 路由 -->    <RouterLink to="/">根目录</RouterLink>    <RouterLink to="/home">首页</RouterLink>    <!-- 其他 -->    <Link href="/">根目录</Link>    <Link href="/home">首页</Link>  </div></template><script setup lang="ts">import Link from "@components/Link.vue";import RouterLink from "@components/RouterLink.vue";</script>

    (可选)步骤 11:渲染 Markdown

    Intlayer 支持在您的 Vue 应用中直接渲染 Markdown 内容。默认情况下,Markdown 被视为纯文本。要将 Markdown 转换为丰富的 HTML,您可以集成一个 Markdown 解析器 markdown-it。

    当您的翻译内容包含格式化内容,如列表、链接或强调时,这尤其有用。

    默认情况下,Intlayer 将 Markdown 渲染为字符串。但 Intlayer 也提供了一种使用 installIntlayerMarkdown 函数将 Markdown 渲染为 HTML 的方式。

    要了解如何使用 intlayer 包声明 Markdown 内容,请参见 markdown 文档。
    main.ts
    复制代码

    复制代码到剪贴板

    import MarkdownIt from "markdown-it";import { createApp, h } from "vue";import { installIntlayer, installIntlayerMarkdown } from "vue-intlayer";const app = createApp(App);app.use(intlayer);const md = new MarkdownIt({  html: true, // 允许 HTML 标签  linkify: true, // 自动识别链接  typographer: true, // 启用智能引号、破折号等排版功能});// 告诉 Intlayer 在需要将 markdown 转换为 HTML 时使用 md.render()installIntlayerMarkdown(app, (markdown) => {  const html = md.render(markdown);  return h("div", { innerHTML: html });});

    注册完成后,您可以使用基于组件的语法直接显示 Markdown 内容:

    vue
    复制代码

    复制代码到剪贴板

    <template>  <div>    <myMarkdownContent />  </div></template><script setup lang="ts">import { useIntlayer } from "vue-intlayer";const { myMarkdownContent } = useIntlayer("my-component");</script>

    配置 TypeScript

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

    Autocompletion

    Translation error

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

    tsconfig.json
    复制代码

    复制代码到剪贴板

    {  // ... 您现有的 TypeScript 配置  "include": [    // ... 您现有的 TypeScript 配置    ".intlayer/**/*.ts", // 包含自动生成的类型  ],}

    Git 配置

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

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

    bash
    复制代码

    复制代码到剪贴板

    #  忽略 Intlayer 生成的文件.intlayer

    VS Code 扩展

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

    从 VS Code 市场安装

    该扩展提供:

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

    建议忽略由 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 来外部管理您的内容。


    Compiler
    Nuxt和Vue
    Alt+→

    在此页面

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

      npm install intlayer vue-intlayernpm install vite-intlayer --save-devnpx intlayer init
      import { createApp } from "vue";import { intlayer } from "vue-intlayer";import App from "./App.vue";import "./style.css";const app = createApp(App);// 在顶层注入提供者app.use(intlayer);// 挂载应用app.mount("#app");
      <script setup lang="ts">import { ref } from "vue";import { useIntlayer } from "vue-intlayer";defineProps({  msg: String,});const {  count,  edit,  checkOut,  officialStarter,  learnMore,  vueDocs,  readTheDocs,} = useIntlayer("helloworld");const countRef = ref(0);</script><template>  <h1>{{ msg }}</h1>  <div class="card">    <button type="button" @click="countRef++">      <count />      {{ countRef }}    </button>    <p v-html="edit"></p>  </div>  <p>    <checkOut />    <a href="https://vuejs.org/guide/quick-start.html#local" target="_blank"      >create-vue</a    >,<officialStarter />  </p>  <p>    <learnMore />    <a      href="https://vuejs.org/guide/scaling-up/tooling.html#ide-support"      target="_blank"      ><vueDocs /></a    >.  </p>  <p class="read-the-docs"><readTheDocs /></p>  <p class="read-the-docs">{{ readTheDocs }}</p></template>
      <template>  <div class="locale-switcher">    <select v-model="selectedLocale" @change="changeLocale">      <option v-for="loc in availableLocales" :key="loc" :value="loc">        {{ getLocaleName(loc) }}      </option>    </select>  </div></template><script setup lang="ts">import { ref, watch } from "vue";import { getLocaleName } from "intlayer";import { useLocale } from "vue-intlayer";// 获取语言信息和 setLocale 函数const { locale, availableLocales, setLocale } = useLocale();// 使用 ref 跟踪选中的语言const selectedLocale = ref(locale.value);// 当选择更改时更新语言const changeLocale = () => setLocale(selectedLocale.value);// 保持 selectedLocale 与全局 locale 同步watch(  () => locale.value,  (newLocale) => {    selectedLocale.value = newLocale;  });</script>
      <script setup lang="ts">import { useIntlayer } from "vue-intlayer";import HelloWorld from "@components/HelloWorld.vue";import LocaleSwitcher from "@components/LocaleSwitcher.vue";import { ref, watch } from "vue";const content = useIntlayer("app"); // 创建相关的 intlayer 声明文件</script><template>  <div>    <LocaleSwitcher />    <a href="https://vite.dev" target="_blank">      <img src="/vite.svg" class="logo" :alt="content.viteLogo" />    </a>    <a href="https://vuejs.org/" target="_blank">      <img src="./assets/vue.svg" class="logo vue" :alt="content.vueLogo" />    </a>  </div>  <HelloWorld :msg="content.title" /></template>
      - https://example.com/about- https://example.com/es/about- https://example.com/fr/about
      npm install vue-routernpx intlayer init
      import {  localeFlatMap,  type Locale,} from 'intlayer';import { createIntlayerClient } from "vue-intlayer";import { createRouter, createWebHistory } from 'vue-router';import HomeView from './views/home/HomeView.vue';import RootView from './views/root/Root.vue';/** * 声明带有语言环境特定路径和元数据的路由。 */const routes = localeFlatMap(({ urlPrefix, locale }) => [  {    path: `${urlPrefix}/`,    name: `Root-${locale}`,    component: RootView,    meta: {      locale,    },  },  {    path: `${urlPrefix}/home`,    name: `Home-${locale}`,    component: HomeView,    meta: {      locale,    },  },]);// 创建路由实例export const router = createRouter({  history: createWebHistory(),  routes,});// 添加导航守卫以处理语言环境router.beforeEach((to, _from, next) => {  const client = createIntlayerClient();  const metaLocale = to.meta.locale as Locale;  // 重用路由元信息中定义的语言环境  client.setLocale(metaLocale);  next();});
      import { createApp } from "vue";import App from "./App.vue";import { router } from "./router";import "./style.css";const app = createApp(App);// 将路由器添加到应用中app.use(router);// 挂载应用app.mount("#app");
      <script setup lang="ts">import LocaleSwitcher from "@components/LocaleSwitcher.vue";</script><template>  <nav>    <LocaleSwitcher />  </nav>  <RouterView /></template>
      <template>  <div class="locale-switcher">    <select v-model="selectedLocale" @change="changeLocale">      <option v-for="loc in availableLocales" :key="loc" :value="loc">        {{ getLocaleName(loc) }}      </option>    </select>  </div></template><script setup lang="ts">import { ref, watch } from "vue";import { useRouter } from "vue-router";import { Locales, getLocaleName, getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";// 获取 Vue Router 实例const router = useRouter();// 获取语言信息和设置语言的函数const { locale, availableLocales, setLocale } = useLocale({  onLocaleChange: (newLocale) => {    // 获取当前路由并创建本地化的 URL    const currentPath = router.currentRoute.value.fullPath;    const localizedPath = getLocalizedUrl(currentPath, newLocale);    // 导航到本地化路由而不重新加载页面    router.push(localizedPath);  },});// 使用 ref 跟踪选中的语言const selectedLocale = ref(locale.value);// 当选择更改时更新语言环境const changeLocale = () => {  setLocale(selectedLocale.value);};// 保持 selectedLocale 与全局语言环境同步watch(  () => locale.value,  (newLocale) => {    selectedLocale.value = newLocale;  });</script>
      <ol>  <li>    <a      hreflang="x-default"      aria-label="切换到英语"      target="_self"      aria-current="page"      href="/doc/get-started"    >      <div>        <span dir="ltr" lang="en">English</span>        <span>英语</span>        <span>EN</span>      </div>    </a>  </li>  <li>    <a      hreflang="es"      aria-label="切换到西班牙语"      target="_self"      href="/es/doc/get-started"    >      <div>        <span dir="ltr" lang="es">Español</span>        <span>西班牙语</span>        <span>ES</span>      </div>    </a>  </li></ol>
      import { watch } from "vue";import { useLocale } from "vue-intlayer";import { getHTMLTextDir } from "intlayer";/** * 组合函数,根据当前语言环境更新 HTML <html> 元素的 `lang` 和 `dir` 属性。 * * @example * // 在你的 App.vue 或全局组件中 * import { useI18nHTMLAttributes } from './composables/useI18nHTMLAttributes' * * useI18nHTMLAttributes() */export const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  // 每当语言环境变化时更新 HTML 属性  watch(    () => locale.value,    (newLocale) => {      if (!newLocale) return;      // 更新语言属性      document.documentElement.lang = newLocale;      // 设置文本方向(大多数语言为从左到右,阿拉伯语、希伯来语等为从右到左)      document.documentElement.dir = getHTMLTextDir(newLocale);    },    { immediate: true }  );};
      <script setup lang="ts">import { useI18nHTMLAttributes } from "@composables/useI18nHTMLAttributes";// 根据当前语言环境应用 HTML 属性useI18nHTMLAttributes();</script><template>  <!-- 你的应用模板 --></template>
      <template>  <a :href="localizedHref" v-bind="$attrs">    <slot />  </a></template><script setup lang="ts">import { computed } from "vue";import { getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";const props = defineProps({  href: {    type: String,    required: true,  },});const { locale } = useLocale();// 检查链接是否为外部链接const isExternalLink = computed(() => /^https?:\/\//.test(props.href || ""));// 为内部链接创建本地化的 hrefconst localizedHref = computed(() =>  isExternalLink.value ? props.href : getLocalizedUrl(props.href, locale.value));</script>
      <template>  <router-link :to="localizedTo" v-bind="$attrs">    <slot />  </router-link></template><script setup lang="ts">import { computed } from "vue";import { getLocalizedUrl } from "intlayer";import { useLocale } from "vue-intlayer";const props = defineProps({  to: {    type: [String, Object],    required: true,  },});const { locale } = useLocale();// 为 router-link 创建本地化的 to 属性const localizedTo = computed(() => {  if (typeof props.to === "string") {    return getLocalizedUrl(props.to, locale.value);  } else {    // 如果 'to' 是一个对象,则本地化 path 属性    return {      ...props.to,      path: getLocalizedUrl(props.to.path ?? "/", locale.value),    };  }});</script>
      <template>  <div>    <!-- Vue 路由 -->    <RouterLink to="/">根目录</RouterLink>    <RouterLink to="/home">首页</RouterLink>    <!-- 其他 -->    <Link href="/">根目录</Link>    <Link href="/home">首页</Link>  </div></template><script setup lang="ts">import Link from "@components/Link.vue";import RouterLink from "@components/RouterLink.vue";</script>
      import MarkdownIt from "markdown-it";import { createApp, h } from "vue";import { installIntlayer, installIntlayerMarkdown } from "vue-intlayer";const app = createApp(App);app.use(intlayer);const md = new MarkdownIt({  html: true, // 允许 HTML 标签  linkify: true, // 自动识别链接  typographer: true, // 启用智能引号、破折号等排版功能});// 告诉 Intlayer 在需要将 markdown 转换为 HTML 时使用 md.render()installIntlayerMarkdown(app, (markdown) => {  const html = md.render(markdown);  return h("div", { innerHTML: html });});
      <template>  <div>    <myMarkdownContent />  </div></template><script setup lang="ts">import { useIntlayer } from "vue-intlayer";const { myMarkdownContent } = useIntlayer("my-component");</script>
      {  // ... 您现有的 TypeScript 配置  "include": [    // ... 您现有的 TypeScript 配置    ".intlayer/**/*.ts", // 包含自动生成的类型  ],}
      #  忽略 Intlayer 生成的文件.intlayer
      #  忽略由 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"  }}