composer不渲染readme,中文readme位于vendor/vendor-name/package-name/下,常见文件名为readme.md、readme或readme.md,需手动用终端或编辑器打开查看,编码须为utf-8无bom。

Composer 本身不渲染 README,更不会“把远程仓库的中文 Readme 渲染到本地”——它只下载包文件,不处理文档展示。你看到的中文 README,要么是手动打开本地文件,要么靠 IDE / GitHub 页面解析,和 Composer 无关。
composer install 后中文 README 在哪?怎么找
安装完成后,中文 README 就在 vendor/vendor-name/package-name/ 目录下,但名字不固定:
- 常见文件名:
README.md、README、readme.md(Linux/macOS 区分大小写) - 没有统一规范,包作者决定放哪、叫什么;有些甚至只有英文版,中文内容混在 docs/ 或 CHANGELOG 里
- 不存在“自动下载并转成 UTF-8 本地副本”的机制——Composer 不做字符编码转换,也不重命名文件
- 如果文件含 BOM 或 GBK 编码,VS Code / PhpStorm 默认可能显示乱码,需手动切换编码(右下角点击编码名选 UTF-8)
为什么用 composer show 看不到 README 内容
composer show 只返回元数据,不是文档查看器:
围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论(Discussion)”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性,以及撰写结论。当用户输入以下任一指令时也会自动触发该功能: - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par
- 输出字段固定:name、version、description、source、homepage、license 等,不含 README 路径或内容
- 即使包主页(homepage)指向 GitHub,
composer show也不会抓取页面 HTML 或 Markdown 渲染结果 - 想快速打开在线 README?用
composer show -s vendor/name查 repository URL,然后粘贴进浏览器
如何让本地终端直接显示中文 README
终端能否正确显示,取决于文件编码 + 终端设置,不是 Composer 的责任:
- 确认 README 是 UTF-8 无 BOM 编码(用
file -i vendor/vender-name/package-name/README.md检查) - Linux/macOS:用
cat或less查看,确保 locale 支持中文(locale | grep UTF应输出UTF-8) - Windows CMD:默认不支持 UTF-8,改用
chcp 65001切换代码页,再type README.md - PowerShell 更可靠:
Get-Content -Encoding UTF8 vendor\vendor-name\package-name\README.md - 别依赖
open或start自动识别——它们调用系统默认应用,可能用记事本(GBK)打开 UTF-8 文件导致乱码
中文文档维护者真正该关心的事
如果你是包作者,想让中文 README 被正确发现和阅读,重点不在“渲染”,而在结构和路径约定:
- README.md 必须放在包根目录,首行是
composer require vendor/name,否则用户第一眼就卡住 - 双语不要拆两个文件,用
## 安装 (Installation)这类二级标题分隔,GitHub 和 VS Code 都能正常折叠/跳转 - 长文档必须放进
docs/目录,文件名小写+短横线,如zh-cn-installation.md,且每个文件顶部加 YAML front matter:--- locale: zh-CN --- - 别指望 Composer 自动生成或同步文档——
docs/目录随代码一起提交,版本号严格对齐composer.json中的version
真正容易被忽略的是:中文 README 不是“附加内容”,而是用户接触你包的第一界面。它不出现在 composer show 里,也不被 post-install-cmd 自动读取,唯一可靠的交付方式,就是让它和 PHP 类文件一样,作为源码的一部分,随 composer install 原样解压到 vendor 目录里。










