maboloshi/github-chinese:README 来源编辑指南
基于 README、仓库元数据和许可证整理 maboloshi/github-chinese 的安装与核验路径。
项目定位
maboloshi/github-chinese 的 README 将项目描述为"GitHub 汉化插件,GitHub 中文化界面。 (GitHub Translation To Chinese)"。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"🌐 兼容环境"下的说明是:浏览器类型 | 支持的脚本管理器 :------------------: | :---------------: Chrome / Chromium 内核 | [Tampermonkey][Tampermonkey], [Violentmonkey][Violentmonkey] Safari(全平台) | [Tampermonkey][Tampermonkey], [Macaque][Macaque], [Stay][Stay] Firefox / Gecko 内核 |。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"v1.9.4.1 (2026-06-16)"和相关条目看,读者可以先判断它是否解决自己的具体问题:关于 GitHub 引入 React 机制导致头部搜索框消失。副作用整个头部导航全部加入忽略规则,无法翻译。。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:区分 React GlobalNav 与页面主体共享的 Primer 弹层,恢复下拉菜单即时、完整翻译。。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"浏览器(Tampermonkey)"等段落中。可确认的线索包括:> [!NOTE] > 版本说明: > - 🚀 开发版:实时更新,每周五自动更新词库 > - 🛡️ 稳定版:每周一同步开发版词库,更稳定。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: README 没有给出可直接复制的安装命令。 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"TOC"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"🔧 本地调试"段落提到:1. 安装 [Tampermonkey][Tampermonkey],并启用 "允许访问文件网址"。 1. 下载词库文件到本地(如:D:\github-chinese\locals.js) 1. 在脚本管理器中修改引用路径:。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:函数拆分细化:watchUpdate → setupMutationObserver + processMutations,transDesc → handleTransClick + requestRemoteTrans + showTransResult。
README 能确认的限制
README 能确认的限制比宣传页面更重要。当前来源没有证明maboloshi/github-chinese具备固定的兼容矩阵、服务等级、性能基准或长期支持承诺。README 只明确写到"> [!IMPORTANT] > 若无效: > 1. 进入 [Tampermonkey][Tampermonkey] 插件设置页 > 1. 将 通用 - 配置模式 设置为高级,进入高级设置模式 > 1. 找到 安全 - 允许脚本访问本地文件 并设置为 外部(@require 和 @resource)"。这类未知项应在选型记录里列为待验证事项,而不是被改写成肯定句。