# npm包中文文档 (npmcn.com)

> npmcn.com is an independent Chinese documentation directory for npm packages. It provides Chinese descriptions, translated READMEs, installation commands, versions and dependencies.

npmcn.com 面向阅读 JavaScript、Node.js 和 npm 生态文档的中文开发者。它是独立社区项目，与 npm 官方没有隶属关系，也不是 npm 安装镜像。
包信息来自 npm Registry；中文 README 为机器翻译，API、命令和配置请结合上游原文核对。版权与许可归原作者所有。
仅发布已有当前有效中文 README 的软件包；不存在、已删除或译文失效的包返回 404。

## 发现文档

- [最新中文文档](https://npmcn.com/): 服务端渲染的包列表，可通过页面上的上一页和下一页继续浏览。
- [最新文档 Markdown 索引](https://npmcn.com/llms-recent.txt): 当前首页精选包的中文文档链接，并非全站目录。
- [完整站点地图索引](https://npmcn.com/sitemap.xml): 跟随 XML 分片获取所有当前可访问的中文包详情，包含真实内容更新时间。
- [关于项目](https://npmcn.com/about/): 数据来源、翻译方式和许可说明。

## 阅读与引用

包详情的规范地址为 /package/{name}/，scope 包为 /package/@scope/{name}/，路径段按 URL 编码；HTML 页面路径统一以 / 结尾。
详情页除译文外，还给出直接取自 npm 元数据的包体积、模块格式（ESM / CommonJS）、TypeScript 类型、Node.js 版本要求、peer 依赖与发布记录，以及据此生成的常见问题。
每个中文详情页通过 rel="alternate" type="text/markdown" 提供 /readme/{name}.md 的精简版本，保留标题、代码块、表格与链接；它与 HTML 来自同一份当前译文。
引用时使用 HTML 规范地址，并注明软件包名、版本和译文更新时间（如有）。译文更新时间与 npm 元数据更新时间是不同字段。
详情页的“原文”链接可对照上游内容；安装仍使用标准 npm install 命令。
无需登录或执行 JavaScript 即可读取正文。搜索结果页不作为文档引用入口，请使用具体包详情。