5分钟搭好Electron-i18n开发环境从GitHub Token到npm run build的完整指南【免费下载链接】i18n The home of Electrons translated documentation项目地址: https://gitcode.com/gh_mirrors/i18n/i18n想快速搭好Electron-i18n 开发环境吗本文带你从零开始走完「创建 GitHub Token → 配置 .env → npm run build」的完整流程5分钟即可让这套本地化文档工具跑起来。Electron-i18n 是 Electron 翻译文档之家负责自动收集英文源文档并同步简体中文、日语、西班牙语等 10 语言的译文。别被国际化工程吓到跟着走即可 ✅ Electron-i18n 到底是什么一句话它把 Electron 官方文档的多语言搬运工工作自动化了。从 Electron 上游仓库拉取最新英文文档写入content/en-US/接收 Crowdin 平台回传的翻译按语言落盘到content/zh-CN/、content/ja-JP/等目录统计各语言翻译进度、词数并生成语言列表打开content/目录就能看到全貌content ├── en-US # 英文源文档API、教程、网站文案 ├── zh-CN # 简体中文 ├── ja-JP # 日语 ├── es-ES # 西班牙语 ├── fr-FR # 法语 ├── ru-RU # 俄语 └── pt-BR # 葡萄牙语巴西每种语言下都是相同的docs/api、docs/tutorial、website三层结构便于 Crowdin 按文件名一一对应翻译。同步规则就写在 crowdin.yml 风格的映射文件crowdin.yml里content/en-US/docs/*.md对应%locale%/docs/%original_file_name%。 小贴士如果你只是想做翻译无需搭建本地环境直接在 Crowdin 平台的 Electron 项目中用浏览器翻译即可本文面向想阅读、运行或改进这套同步工具的开发者。✅ 开始前的 3 个前置条件Node.js ≥ 10package.json中engines的要求推荐 14因为脚本用 ts-node 直接跑 TypeScriptnpm随 Node.js 自带一个GitHub 账号用于生成 Tokennode -v # 确认版本 npm -v第 1 步克隆 Electron-i18n 仓库打开终端执行git clone https://gitcode.com/gh_mirrors/i18n/i18n cd i18n克隆完成后你会看到核心文件路径作用package.json定义所有 npm 脚本与依赖.env.example环境变量模板放 Token 的地方crowdin.ymlCrowdin 翻译映射规则content/各语言文档内容script/collect、build 等核心脚本lib/解析器、语言列表等模块第 2 步创建 GitHub Token无需任何权限Electron-i18n 需要通过 GitHub API 拉取上游 Electron 仓库的文档见script/collect.ts中的 Octokit 客户端因此必须配置一个 Token。它不需要任何特殊权限No special scopes needed一个最普通的 Personal Access Token 就够用。操作步骤在 GitHub 网页完成登录 GitHub点击右上角头像 →Settings左侧滚动到底部 →Developer settingsPersonal access tokens→Tokens (classic)→Generate new token (classic)填写一个便于识别的 note如electron-i18n权限全部留空点击生成立刻复制这个ghp_...开头的字符串关闭页面后就看不到了第 3 步一分钟配置 .env 文件仓库贴心地准备好了模板.env.example内容只有一行GH_TOKEN。两步完成配置cp .env.example .env然后编辑.env把你的 Token 填进去GH_TOKENghp_你的Token粘贴在这里⚠️ 注意.env已被加入.gitignore不会被误提交到仓库放心填script/collect.ts里通过process.env.GH_TOKEN读取它名称不能改不需要配置任何 Crowdin 相关变量本地跑 build 用不到第 4 步安装依赖并运行 npm run buildnpm install npm run build看到各任务依次完成、无报错输出即代表Electron-i18n 开发环境搭建成功 现在你可以放心地修改脚本、调试解析逻辑改完直接npm run build验证。 build 到底做了什么build实际上是npm-run-all build:*的串联共 4 个子任务见package.json的 scripts脚本做什么产物build:stats从 Electron 官网抓取各语言翻译进度script/stats.tsstats.jsonbuild:module用解析器遍历content/下所有语言的 Markdownscript/build-module.ts、lib/parsers/解析后的文档结构build:readme按进度排序生成语言列表script/readme.ts、lib/locales.ts更新readme.mdbuild:wordcount统计各语言总词数script/wordcount.tswordcount.md语言列表由lib/locales.ts动态读取content/目录生成新增一个语言目录它就会自动出现在统计和 README 里。⚡ 常用命令速查表命令用途npm run collect从上游拉取最新英文源文档并清理过期文件需要 Tokennpm run build执行全部构建任务最常用npm test先 build 再跑 Mocha 测试 Prettier 检查npm run upload-crowdin-glossary生成并上传 Crowdin 术语表日常开发闭环就是npm run collect→ 检查content/变化 →npm test。仓库还预置了.vscode/launch.json在 VS Code 中可直接调试Collect、Build module两个任务。 常见问题排查Q1collect报 403 / rate limit说明 Token 没生效。确认.env中GH_TOKEN后面没有多余空格且改完后重新运行命令环境变量只在启动时读取。Q2Token 真的必须开权限吗不需要。文档明确说明No special scopes needed零权限 Token 即可满足拉取公开仓库的需求。Q3build 很慢或内存吃紧build:module会遍历 7 语言、130 份 Markdown 文档首次运行耗时属正常现象。Q4readme.md 写着 DEPRECATED还能学吗官方翻译协作已迁移到 Crowdin 平台本仓库定位为工具与内容存档但其 collect/build 流程完整可用依然是学习文档本地化工程的好样本。写在最后恭喜你已经掌握了Electron-i18n 开发环境的完整搭建流程Token →.env→npm install→npm run build。接下来推荐两个练手方向运行npm run collect对比content/en-US/的新变化理解上游同步机制修改lib/locales.ts观察语言排序逻辑如何影响readme.md与统计报告理解文档如何从英文源走到 10 种语言对做任何开源本地化项目都有直接帮助动手试试吧 【免费下载链接】i18n The home of Electrons translated documentation项目地址: https://gitcode.com/gh_mirrors/i18n/i18n创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考