开源世界的好想法,
值得被更多人看懂。
- 数据来源
- npm Registry 公开数据
- 同步方式
- 持续增量 + 每 7 天对账
- 翻译方式
- 机器翻译,代码不翻译
- 过期处理
- 原文变化即下线旧译文
在这里,你可以做什么
搜索有中文文档的 npm 软件包,了解安装方式、版本、开源许可与依赖关系;通过中文文档,更轻松地理解一个工具如何使用。你也可以随时切换到原文,查阅更准确的技术细节。
内容是怎样生产的
同步 npm Registry
从 registry.npmjs.org 读取公开的包元数据与 README:首次全量枚举,之后持续跟随 npm 的变更流增量同步,并每 7 天做一次全量对账,补齐遗漏与删除。
机器翻译正文
README 渲染为 HTML 后交给自建的翻译服务,只翻译文本节点;代码块、行内代码、链接地址和文档结构保持原样,避免命令和 API 名称被误译。
校验译文是否过期
每篇译文都记录了它所对应原文的指纹。只有当指纹与 npm 当前 README 完全一致时才会展示;作者更新 README 后,旧译文立即下线,等待重新翻译。
补充一手数据
在译文之外,直接从 npm 元数据计算包体积、模块格式(ESM / CommonJS)、TypeScript 类型、Node.js 版本要求、peer 依赖与发布记录,并整理成常见问题,不依赖人工估计。
清洗与发布
所有内容经过白名单 HTML 清洗,移除脚本和嵌入框架;文档中的外部链接标记为 nofollow。首页只收录中文正文达到最低长度要求的文档,过短的 README 不进入推荐列表。
页面上的每一项信息从哪里来
版本、许可证、依赖、维护者、发布时间、包体积、模块格式和类型声明,全部读取自 npm 上该包最新版本的 package.json 与发布记录;中文 README 是对 npm 当前 README 的机器翻译;“常见问题”中的回答由这些元数据按固定规则生成,例如“是否支持 TypeScript”取决于包是否声明了 types 入口。详情页分别标明 npm 元数据更新时间与中文译文更新时间。
它的局限
中文由机器翻译生成,可能存在语义或技术用词上的偏差;涉及 API、配置和命令时,请结合项目原始文档使用。我们不评测软件包的代码质量或安全性,发布频率、下载量之类的信号也不能单独说明一个包是否可靠。许可证解读只是概括,不构成法律意见。软件包和文档的版权与许可归原作者所有。
一个独立的中文社区项目
npmcn.com 与 npm 官方没有隶属关系,也不是 npm 安装镜像。安装软件包仍使用标准的 npm install 包名。我们希望减少阅读开源文档时的语言障碍,让开发者把更多时间留给构建、分享与创造。
纠错与联系
发现译文错误、过期内容或其他问题,可以先切换到“原文”核对;原始文档本身的问题请到对应软件包的源码仓库反馈。
阅读与引用
引用文档时,请链接具体软件包的中文详情页,并注明包名、版本以及页面提供的译文更新时间。每篇中文 README 同时提供 Markdown 版本,正文无需登录或执行 JavaScript 即可读取。机器阅读入口见 项目说明、最新文档索引及完整站点地图。
从一个软件包开始