示例
GitHub 上 examples/ 下的可运行项目 — 每个项目都有自己的配置、已提交的区域设置输出和 README。您可以在没有 API 密钥的情况下浏览翻译文件;重新运行翻译需要提供商密钥(提供商和模型)。
独立运行 (npx degit)
在不克隆完整仓库的情况下复制一个示例。
Node.js 示例
每个 Node.js 示例都声明了与当前包版本匹配的 ai-i18n-tools 发布插入符号范围,并从 npm 安装 CLI:
npx degit wsj-br/ai-i18n-tools/examples/<name> <name>
cd <name>
pnpm installPython 示例
python-streamlit、python-flask、python-fastapi 和 python-gettext 没有 package.json。下表中的 degit 命令是有效的。您也可以从 GitHub Release 下载 ai-i18n-tools-python-examples.zip。该 zip 文件包含相同的四个目录。它不属于 npm 包,也不在独立可执行文件中。
python-streamlit、python-flask 和 python-fastapi 使用 virtualenv 和 pip install -r requirements.txt。python-gettext 仅使用标准库。使用 独立可执行文件 进行翻译。
npx degit wsj-br/ai-i18n-tools/examples/python-streamlit python-streamlit
cd python-streamlit
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt在 Windows 上,激活 .venv\Scripts\activate。
如果您克隆了 整个 ai-i18n-tools 仓库,请在仓库根目录运行 pnpm install 和 pnpm run build,然后运行 cd examples/<name>。工作区 (Node.js) 示例通过其 pnpm run i18n:* 脚本使用本地 CLI,或者在 PATH 设置 后使用裸 ai-i18n-tools …。该检出中的 Python 示例在构建后使用 node ../../bin/ai-i18n-tools.mjs 进行翻译。请参阅 安装 — 克隆的 monorepo。
.NET 示例
dotnet-console 和 dotnet-resx 没有 package.json。下表中的 degit 命令有效。您还可以从 GitHub Release 下载 ai-i18n-tools-dotnet-examples.zip。该 zip 文件包含相同的两个目录和 assets/dotnet,项目通过 ../../assets/dotnet 进行编译。它不是 npm 包的一部分,也不在独立可执行文件中。在该 zip 文件之前发布的版本不包含它。
两者都是 xUnit 项目。dotnet-console 检查 I18n.cs。dotnet-resx 检查 I18nResx.cs 和 .resx 卫星程序集。两者都不调用翻译 API。在该目录中运行 dotnet test。从完整克隆中,在仓库根目录运行 pnpm test:dotnet 会同时运行两者,并在 dotnet 不在 PATH 上时跳过。
解压 ai-i18n-tools-dotnet-examples.zip,然后从示例目录运行检查。该归档文件将 examples/ 和 assets/dotnet 并排放置,这是项目编译的路径:
cd examples/dotnet-console
dotnet testdegit 复制一个目录,但不包含 assets/dotnet。这些编译链接在完整克隆中或解压 zip 文件后解析。
哪个示例适合我的项目?
- 一个 JS/TS 应用程序:console-app(最小的)或 nextjs-app。指南:为 JS/TS 应用程序添加 i18n。
- 一个 Python 应用程序:python-streamlit、python-flask 或 python-fastapi。指南:为 Python 应用程序添加 i18n。
- 一个 Django 或 GNU gettext 应用程序:python-gettext(一个 gettext 命令行工具;没有 Django 示例目录)。指南:为 Django / Python gettext 应用程序添加 i18n。
- 一个 .NET 辅助程序:dotnet-console (
I18n.cs) 或 dotnet-resx (I18nResx.cs和.resx卫星程序集)。指南:为 .NET 应用程序添加 i18n 和 为 .NET ResourceManager 应用程序添加 i18n。 - 一个网站或文档站点:docusaurus-docs、vitepress-docs、astro-docs、nextra-docs、fumadocs-docs、astro-website、plain-html 或 plain-html-docs。指南:为网站或文档站点添加 i18n。
- 应用程序旁边的仓库 README:console-app 或 nextjs-app(nextjs 示例也有一个文档站点)。指南:为您的 README 和 Markdown 文档添加 i18n。
- 其他:multi-provider、test-markdown 和 intlayer-migration。
示例列表
| 示例 | 最适合 | 使用 degit 复制 | 运行 |
|---|---|---|---|
| console-app | 最小的工作应用程序,包含 t() UI 字符串 + README 翻译 | npx degit wsj-br/ai-i18n-tools/examples/console-app console-app | pnpm start |
| nextjs-app | React / Next.js + 复数 + 仪表板;嵌套的 Docusaurus 文档 + 扁平 README + SVG 资源 | npx degit wsj-br/ai-i18n-tools/examples/nextjs-app nextjs-app | pnpm dev(应用 :3030;cd docs-site && pnpm start 用于文档 :3040) |
| docusaurus-docs | 仅 Docusaurus 文档站点(docusaurus 预设) | npx degit wsj-br/ai-i18n-tools/examples/docusaurus-docs docusaurus-docs | pnpm start(:3100;构建 + 服务,区域设置菜单正常工作) |
| astro-website | Astro 登录页面:全页 HTML + t() 混合 | npx degit wsj-br/ai-i18n-tools/examples/astro-website astro-website | pnpm dev |
| astro-docs | Astro Starlight 文档站点 | npx degit wsj-br/ai-i18n-tools/examples/astro-docs astro-docs | pnpm dev (:3050) |
| vitepress-docs | VitePress 文档站点 + 主题 JSON (pt-BR, zh-Hans) | npx degit wsj-br/ai-i18n-tools/examples/vitepress-docs vitepress-docs | pnpm run docs:dev (:3060) |
| nextra-docs | Nextra 4 MDX + _meta.ts / 字典 .ts shell,外加一个 t() 服务器组件(pt-BR、zh-Hans) | npx degit wsj-br/ai-i18n-tools/examples/nextra-docs nextra-docs | pnpm run dev (:3070) |
| fumadocs-docs | Fumadocs 4 MDX + meta.json / UI 目录 (pt, zh, dot 解析器) | npx degit wsj-br/ai-i18n-tools/examples/fumadocs-docs fumadocs-docs | pnpm run dev (:3080) |
| plain-html | 纯 HTML + data-i18n* 标记;静态区域设置 JSON(仪表板式 UI) | npx degit wsj-br/ai-i18n-tools/examples/plain-html plain-html | pnpm dev(:3090) |
| plain-html-docs | 作为文档的纯 HTML:每个语言环境一页,本地化图像,hreflang | npx degit wsj-br/ai-i18n-tools/examples/plain-html-docs plain-html-docs | pnpm dev (:3092) |
| multi-provider | 选择或基准测试 LLM 提供商 (-P / --provider) | npx degit wsj-br/ai-i18n-tools/examples/multi-provider multi-provider | ai-i18n-tools translate-docs -P openai --force |
| test-markdown | 回归测试 Markdown / CJK 翻译 (梵文, MDX) | npx degit wsj-br/ai-i18n-tools/examples/test-markdown test-markdown | pnpm build |
| intlayer-migration | Intlayer .content.ts → t()(migrate-intlayer,重置 + AI 代理报告) | npx degit wsj-br/ai-i18n-tools/examples/intlayer-migration intlayer-migration | pnpm reset && pnpm dev(:3091) |
| intlayer-translate | 保留 Intlayer,就地填充缺失的区域设置(translate-intlayer;en + pt-BR 已提供,es + zh-Hans 缺失) | npx degit wsj-br/ai-i18n-tools/examples/intlayer-translate intlayer-translate | pnpm reset && pnpm translate (pnpm dev :3093) |
| python-streamlit | Streamlit 仪表板,t() / _(),源字符串 JSON | npx degit wsj-br/ai-i18n-tools/examples/python-streamlit python-streamlit | python3 -m venv .venv && pip install -r requirements.txt && streamlit run app.py |
| python-flask | Flask + Jinja,t() / _(),源字符串 JSON | npx degit wsj-br/ai-i18n-tools/examples/python-flask python-flask | python3 -m venv .venv && pip install -r requirements.txt && flask --app app run |
| python-fastapi | FastAPI,ContextVar 区域设置,t() / _(),源字符串 JSON | npx degit wsj-br/ai-i18n-tools/examples/python-fastapi python-fastapi | python3 -m venv .venv && pip install -r requirements.txt && uvicorn app:app |
| python-gettext | 现有的 GNU gettext CLI;extract / translate-ui 刷新 .po 和 .mo | npx degit wsj-br/ai-i18n-tools/examples/python-gettext python-gettext | python3 app.py --lang es |
| dotnet-console | xUnit 对 I18n.cs 的检查:嵌入式 JSON、区域性回退、{0}、复数形式和 Configure | npx degit wsj-br/ai-i18n-tools/examples/dotnet-console dotnet-console | dotnet test |
| dotnet-resx | xUnit 对 I18nResx.cs 和源字符串 .resx 卫星程序集 的检查 | npx degit wsj-br/ai-i18n-tools/examples/dotnet-resx dotnet-resx | dotnet test |
每个 示例 名称都链接到其 GitHub README,其中包含完整的设置、命令和项目布局 — 或者浏览存储库中的示例索引。
Node.js 示例在 pnpm install 之后从 npm 安装 CLI。四个 Python 示例使用 venv 和 pip(python-gettext 仅使用标准库)以及 独立可执行文件 进行翻译。这两个 .NET 示例是 xUnit 项目。使用 dotnet test 运行它们。它们也位于 GitHub Release 上的 ai-i18n-tools-dotnet-examples.zip 中。
免责声明
产品名称和图标归其各自所有者所有,仅用于标识目的。本软件与上述品牌无关,亦未获得其认可。