@intlayer/docs 5.5.12 → 5.6.0

package/docs/zh/intlayer_with_nuxt.md

@@ -14,6 +14,7 @@ slugs:
   - doc
   - environment
   - nuxt-and-vue
+applicationTemplate: https://github.com/aymericzip/intlayer-nuxt-template
 ---
 
 # 使用 Intlayer 和 Nuxt 开始国际化（i18n）

package/docs/zh/intlayer_with_react_native+expo.md

@@ -14,6 +14,7 @@ slugs:
   - doc
   - environment
   - react-native-and-expo
+applicationTemplate: https://github.com/aymericzip/intlayer-react-native-template
 ---
 
 # 使用 Intlayer 和 React Native 开始国际化（i18n）

package/docs/zh/intlayer_with_vite+preact.md

@@ -14,6 +14,7 @@ slugs:
   - doc
   - environment
   - vite-and-preact
+applicationTemplate: https://github.com/aymericzip/intlayer-vite-preact-template
 ---
 
 # 使用 Intlayer、Vite 和 Preact 开始国际化（i18n）
@@ -43,17 +44,17 @@ slugs:
 
 ```bash packageManager="npm"
 npm install intlayer preact-intlayer
-npm install --save-dev vite-intlayer
+npm install vite-intlayer --save-dev
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer preact-intlayer
-pnpm add --save-dev vite-intlayer
+pnpm add vite-intlayer --save-dev
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer preact-intlayer
-yarn add --save-dev vite-intlayer
+yarn add vite-intlayer --save-dev
 ```
 
 - **intlayer**

package/docs/zh/intlayer_with_vite+react.md

@@ -15,10 +15,13 @@ slugs:
   - doc
   - environment
   - vite-and-react
----
+applicationTemplate: https://github.com/aymericzip/intlayer-vite-react-template
+youtubeVideo: https://www.youtube.com/watch?v=dS9L7uJeak4---
 
 # 使用 Intlayer 结合 Vite 和 React 开始国际化 (i18n)
 
+<iframe title="The best i18n solution for Vite and React? 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/dS9L7uJeak4?si=VaKmrYMmXjo3xpk2"/>
+
 请参阅 GitHub 上的[应用模板](https://github.com/aymericzip/intlayer-vite-react-template)。
 
 ## 什么是 Intlayer？
@@ -42,17 +45,17 @@ slugs:
 
 ```bash packageManager="npm"
 npm install intlayer react-intlayer
-npm install --save-dev vite-intlayer
+npm install vite-intlayer --save-dev
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer react-intlayer
-pnpm add --save-dev vite-intlayer
+pnpm add vite-intlayer --save-dev
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer react-intlayer
-yarn add --save-dev vite-intlayer
+yarn add vite-intlayer --save-dev
 ```
 
 - **intlayer**

package/docs/zh/intlayer_with_vite+solid.md

@@ -14,6 +14,7 @@ slugs:
   - doc
   - environment
   - vite-and-solid
+# applicationTemplate: https://github.com/aymericzip/intlayer-vite-solid-template
 ---
 
 # 使用 Intlayer 和 Vite 及 Solid 开始国际化（i18n）
@@ -43,17 +44,17 @@ slugs:
 
 ```bash packageManager="npm"
 npm install intlayer solid-intlayer
-npm install --save-dev vite-intlayer
+npm install vite-intlayer --save-dev
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer solid-intlayer
-pnpm add --save-dev vite-intlayer
+pnpm add vite-intlayer --save-dev
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer solid-intlayer
-yarn add --save-dev vite-intlayer
+yarn add vite-intlayer --save-dev
 ```
 
 - **intlayer**

package/docs/zh/intlayer_with_vite+svelte.md

@@ -14,6 +14,7 @@ slugs:
   - doc
   - environment
   - vite-and-svelte
+# applicationTemplate: https://github.com/aymericzip/intlayer-vite-solid-template
 ---
 
 # 使用 Intlayer、Vite 和 Svelte 开始国际化（i18n）
@@ -43,17 +44,17 @@ slugs:
 
 ```bash packageManager="npm"
 npm install intlayer svelte-intlayer
-npm install --save-dev vite-intlayer
+npm install vite-intlayer --save-dev
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer svelte-intlayer
-pnpm add --save-dev vite-intlayer
+pnpm add vite-intlayer --save-dev
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer svelte-intlayer
-yarn add --save-dev vite-intlayer
+yarn add vite-intlayer --save-dev
 ```
 
 - **intlayer**

package/docs/zh/intlayer_with_vite+vue.md

@@ -14,6 +14,7 @@ slugs:
   - doc
   - environment
   - vite-and-vue
+applicationTemplate: https://github.com/aymericzip/intlayer-vite-vue-template
 ---
 
 # 使用 Intlayer 和 Vite 及 Vue 开始国际化（i18n）
@@ -41,17 +42,17 @@ slugs:
 
 ```bash packageManager="npm"
 npm install intlayer vue-intlayer
-npm install --save-dev vite-intlayer
+npm install vite-intlayer --save-dev
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer vue-intlayer
-pnpm add --save-dev vite-intlayer
+pnpm add vite-intlayer --save-dev
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer vue-intlayer
-yarn add --save-dev vite-intlayer
+yarn add vite-intlayer --save-dev
 ```
 
 - **intlayer**
@@ -969,7 +970,7 @@ Intlayer 支持在您的 Vue 应用中直接渲染 Markdown 内容。默认情
 
 > 要了解如何使用 `intlayer` 包声明 Markdown 内容，请参见 [markdown 文档](https://github.com/aymericzip/intlayer/tree/main/docs/zh/dictionary/markdown.md)。
 
-```ts filename="main.ts"
+```ts fileName="main.ts"
 import MarkdownIt from "markdown-it";
 import { createApp, h } from "vue";
 import { installIntlayer, installIntlayerMarkdown } from "vue-intlayer";

package/docs/zh/mcp_server.md

@@ -1,8 +1,8 @@
 ---
 createdAt: 2025-06-07
-updatedAt: 2025-06-07
+updatedAt: 2025-07-11
 title: MCP 服务器文档
-description: 探索 MCP 服务器的功能和设置，优化您的服务器管理和操作。
+description: 探索 MCP 服务器的功能和设置，以优化您的服务器管理和操作。
 keywords:
   - MCP 服务器
   - 服务器管理
@@ -18,35 +18,61 @@ slugs:
 
 # Intlayer MCP 服务器
 
-**Intlayer MCP（模型上下文协议）服务器** 提供了针对 Intlayer 生态系统量身定制的 AI 驱动 IDE 辅助。该服务器专为现代开发环境设计，如 **Cursor**、**GitHub Copilot 工作区**，以及任何支持 MCP 协议的 IDE，基于您的项目设置，提供上下文相关的实时支持。
+**Intlayer MCP（模型上下文协议）服务器** 提供针对 Intlayer 生态系统量身定制的 AI 驱动的 IDE 辅助。
+
+## 我可以在哪里使用它？
+
+- 在现代开发环境中，如 **Cursor**、**VS Code**，以及任何支持 MCP 协议的 IDE。
+- 在您喜欢的 AI 助手上，如 **Claude Desktop**、**Gemini**、**ChatGPT** 等。
 
 ## 为什么使用 Intlayer MCP 服务器？
 
-通过在您的 IDE 中启用 Intlayer MCP 服务器，您将获得：
+通过在您的 IDE 中启用 Intlayer MCP 服务器，您将解锁以下功能：
+
+- **上下文感知文档**
+  MCP 服务器加载并展示 Intlayer 的文档，以加快您的设置、迁移等过程。
+  这确保代码建议、命令选项和说明始终是最新且相关的。
+
+- **智能 CLI 集成**
+  直接从您的 IDE 界面访问并运行 Intlayer CLI 命令。使用 MCP 服务器，您可以让您的 AI 助手运行诸如 `intlayer dictionaries build` 来更新词典，或 `intlayer dictionaries fill` 来填充缺失的翻译。
+
+  > 查看完整的命令和选项列表，请参阅 [Intlayer CLI 文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_cli.md)。
+
+## 本地服务器（stdio）与远程服务器（SSE）
+
+MCP 服务器可以通过两种方式使用：
+
+- 本地服务器（stdio）
+- 远程服务器（SSE）
+
+### 本地服务器（stdio）（推荐）
 
-- **智能 CLI 集成**  
-  直接从您的 IDE 界面访问并运行 Intlayer CLI 命令。完整的命令和选项列表请参阅 [Intlayer CLI 文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_cli.md)。
+Intlayer 提供了一个可以在您的机器上本地安装的 NPM 包。它可以安装在您喜欢的 IDE 中，如 VS Code、Cursor，以及您的本地助手应用程序，如 ChatGPT、Claude Desktop 等。
 
-- **上下文感知文档**  
-  MCP 服务器会加载并展示与您项目中使用的 Intlayer 版本对应的文档。这确保了代码建议、命令选项和说明始终是最新且相关的。
+这是使用 MCP 服务器的推荐方式，因为它集成了 MCP 服务器的所有功能，包括 CLI 工具。
 
-- **AI 辅助开发**  
-  通过项目感知的建议和自动补全，AI 助手可以解释您的代码，推荐 CLI 用法，或根据您当前的文件建议如何使用 Intlayer 的特定功能。
+### 远程服务器（SSE）
 
-- **轻量且即时设置**  
-  无需服务器维护或繁重安装。只需配置您的 `.cursor/mcp.json` 或等效的 MCP 配置文件，即可开始使用。
+MCP 服务器也可以通过 SSE 传输方式远程使用。该服务器由 Intlayer 托管，地址为 https://mcp.intlayer.org。该服务器可公开访问，无需任何身份验证，且免费使用。
+
+请注意，远程服务器不集成 CLI 工具、AI 自动补全等功能。远程服务器仅用于与文档交互，以帮助您的 AI 助手使用 Intlayer 生态系统。
+
+> 由于服务器托管成本，远程服务器的可用性无法保证。我们限制同时连接的数量。我们建议使用本地服务器（stdio）传输方式，以获得最可靠的体验。
 
 ---
 
-## 设置 Cursor
+## 在 Cursor 中的设置
+
+请按照[官方文档](https://docs.cursor.com/context/mcp)配置 Cursor 中的 MCP 服务器。
 
 在您的项目根目录下，添加以下 `.cursor/mcp.json` 配置文件：
 
-```json
+### 本地服务器（stdio）（推荐）
+
+```json fileName=".cursor/mcp.json"
 {
   "mcpServers": {
     "intlayer": {
-      "type": "stdio",
       "command": "npx",
       "args": ["-y", "@intlayer/mcp"]
     }
@@ -54,19 +80,36 @@ slugs:
 }
 ```
 
-这告诉您的 IDE 使用 `npx` 启动 Intlayer MCP 服务器，确保始终使用最新可用版本，除非您进行了版本固定。
+### 远程服务器（SSE）
+
+要通过服务器发送事件（SSE）连接到远程 Intlayer MCP 服务器，您可以配置 MCP 客户端以连接到托管服务。
+
+```json fileName=".cursor/mcp.json"
+{
+  "mcpServers": {
+    "intlayer": {
+      "url": "https://mcp.intlayer.org",
+      "transport": "sse"
+    }
+  }
+}
+```
+
+这会告诉您的 IDE 使用 `npx` 启动 Intlayer MCP 服务器，确保它始终使用最新可用版本，除非您进行了版本固定。
 
 ---
 
-## 设置 VS Code
+## 在 VS Code 中设置
+
+请参阅[官方文档](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)以配置 VS Code 中的 MCP 服务器。
 
 要在 VS Code 中使用 Intlayer MCP 服务器，您需要在工作区或用户设置中进行配置。
 
-### 工作区配置
+### 本地服务器（stdio）（推荐）
 
-在项目根目录下创建 `.vscode/mcp.json` 文件：
+在你的项目根目录下创建一个 `.vscode/mcp.json` 文件：
 
-```json
+```json fileName=".vscode/mcp.json"
 {
   "servers": {
     "intlayer": {
@@ -78,98 +121,88 @@ slugs:
 }
 ```
 
-### 在 VS Code 中使用 MCP 服务器
-
-1. **启用代理模式**：打开聊天视图（Mac 上为 ⌃⌘I，Windows/Linux 上为 Ctrl+Alt+I），并从下拉菜单中选择 **代理** 模式。
+### 远程服务器（SSE）
 
-2. **访问工具**：点击 **工具** 按钮以查看可用的 Intlayer 工具。您可以根据需要选择或取消选择特定工具。
+要连接到使用服务器发送事件（SSE）的远程 Intlayer MCP 服务器，你可以配置你的 MCP 客户端以连接到托管服务。
 
-3. **直接引用工具**：在提示中通过输入 `#` 后跟工具名称，直接引用工具。
-
-4. **工具确认**：默认情况下，VS Code 会在运行工具前请求确认。使用 **继续** 按钮的选项，可以自动确认当前会话、工作区或所有未来调用的工具。
-
-### 管理服务器
-
-- 从命令面板运行 **MCP: 列出服务器** 以查看已配置的服务器
-- 根据需要启动、停止或重启 Intlayer MCP 服务器
-- 通过选择服务器并选择 **显示输出** 来查看服务器日志以进行故障排除
-
-有关 VS Code MCP 集成的更多详细信息，请参阅[官方 VS Code MCP 文档](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)。
+```json fileName=".vscode/mcp.json"
+{
+  "servers": {
+    "intlayer": {
+      "url": "https://mcp.intlayer.org",
+      "type": "sse"
+    }
+  }
+}
+```
 
 ---
 
-## 通过 CLI 使用 MCP 服务器
+## 在 ChatGPT 中设置
 
-您也可以直接从命令行运行 Intlayer MCP 服务器，以便进行测试、调试或与其他工具集成。
+### 远程服务器（SSE）
 
-### 安装 MCP 服务器
+请按照[官方文档](https://platform.openai.com/docs/mcp#test-and-connect-your-mcp-server)配置 ChatGPT 中的 MCP 服务器。
 
-首先，全局安装 MCP 服务器包，或通过 npx 使用：
+1. 访问 [promt dashboard](https://platform.openai.com/prompts)
+2. 点击 “+ Create”
+3. 点击 “Tools (Create or +)”
+4. 选择 “MCP Server”
+5. 点击 “Add new”
+6. 填写以下字段：
 
-```bash
-# 全局安装
-npm install -g @intlayer/mcp
+   - URL: https://mcp.intlayer.org
+   - Label: Intlayer MCP 服务器
+   - Name: intlayer-mcp-server
+   - Authentication: 无
 
-# 或直接使用 npx（推荐）
-npx @intlayer/mcp
-```
+7. 点击 “Save”
 
-### 启动服务器
-
-要启动带有调试和测试用检查器的 MCP 服务器：
-
-```bash
-# 使用内置的启动命令
-npm run start
-
-# 或直接使用 npx
-npx @modelcontextprotocol/inspector npx @intlayer/mcp
-```
-
-这将启动带有检查器界面的 MCP 服务器，允许您：
+---
 
-- 测试 MCP 协议通信
-- 调试服务器响应
-- 验证工具和资源的实现
-- 监控服务器性能
+## 在 Claude Desktop 中设置
 
-### 开发使用
+按照[官方文档](https://modelcontextprotocol.io/quickstart/user#2-add-the-filesystem-mcp-server)配置 Claude Desktop 中的 MCP 服务器。
 
-出于开发和测试目的，您可以以多种模式运行服务器：
+配置文件路径：
 
-```bash
-# 构建并以开发模式启动
-npm run dev
+- macOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
+- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
 
-# 使用自定义配置运行
-node dist/cjs/index.cjs
+### 本地服务器（stdio）（推荐）
 
-# 测试服务器功能
-npm test
+```json fileName="claude_desktop_config.json"
+{
+  "mcpServers": {
+    "intlayer": {
+      "command": "npx",
+      "args": ["-y", "@intlayer/mcp"]
+    }
+  }
+}
 ```
 
-服务器将公开 Intlayer 特定的工具和资源，任何兼容 MCP 的客户端都可以使用，而不仅限于 Cursor 或其他 IDE。
-
 ---
 
-## 功能概览
+## 通过命令行界面使用 MCP 服务器
 
-| Feature    | Description                                    |
-| ---------- | ---------------------------------------------- |
-| CLI 支持   | 运行 `intlayer` 命令，获取使用提示和内联参数   |
-| 版本化文档 | 自动检测并加载与您当前 Intlayer 版本匹配的文档 |
-| 自动补全   | 输入时智能提供命令和配置建议                   |
-| 插件兼容   | 兼容支持 MCP 标准的 IDE 和工具                 |
+您也可以直接从命令行运行 Intlayer MCP 服务器，用于测试、调试或与其他工具集成。
 
----
-
-## 有用链接
+```bash
+# 全局安装
+npm install -g @intlayer/mcp
 
-- [Intlayer CLI 文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_cli.md)
-- [Intlayer GitHub 仓库](https://github.com/aymericzip/intlayer)
+# 或直接使用 npx（推荐）
+npx @intlayer/mcp
+```
 
 ---
 
 ## 文档历史
 
-- 5.5.10 - 2025-06-29: 初始化历史
+| 版本   | 日期       | 变更内容                      |
+| ------ | ---------- | ----------------------------- |
+| 5.5.12 | 2025-07-11 | 添加 ChatGPT 的设置           |
+| 5.5.12 | 2025-07-10 | 添加 Claude Desktop 的设置    |
+| 5.5.12 | 2025-07-10 | 添加 SSE 传输和远程服务器支持 |
+| 5.5.10 | 2025-06-29 | 初始化历史记录                |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/docs",
-  "version": "5.5.12",
+  "version": "5.6.0",
   "private": false,
   "description": "Intlayer documentation",
   "keywords": [
@@ -49,8 +49,8 @@
     "legal"
   ],
   "dependencies": {
-    "@intlayer/config": "5.5.11",
-    "intlayer": "5.5.11"
+    "@intlayer/config": "5.6.0",
+    "intlayer": "5.6.0"
   },
   "devDependencies": {
     "@types/node": "^22.15.30",
@@ -65,16 +65,16 @@
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
     "vitest": "^3.2.2",
-    "@intlayer/api": "5.5.11",
-    "@intlayer/cli": "5.5.11",
-    "@utils/ts-config-types": "1.0.4",
+    "@utils/ts-config": "1.0.4",
     "@utils/tsup-config": "1.0.4",
-    "@utils/ts-config": "1.0.4"
+    "@utils/ts-config-types": "1.0.4",
+    "@intlayer/api": "5.6.0",
+    "@intlayer/cli": "5.6.0"
   },
   "peerDependencies": {
-    "@intlayer/cli": "5.5.11",
-    "@intlayer/api": "5.5.11",
-    "@intlayer/config": "5.5.11"
+    "@intlayer/api": "5.6.0",
+    "@intlayer/cli": "5.6.0",
+    "@intlayer/config": "5.6.0"
   },
   "engines": {
     "node": ">=14.18"

package/src/common.ts

@@ -67,6 +67,8 @@ export type FileMetadata = {
   updatedAt: string;
   createdAt: string;
   author?: string;
+  youtubeVideo?: string;
+  applicationTemplate?: string;
 };
 
 export const formatMetadata = (