如何在Composer配置文件中指定中文文档的存放路径并自动解压

大辰吖_6677

大辰吖_6677

2026-07-06

463人浏览

原创

composer 不支持中文文档路径配置,仅安装包内文件;文档语言版本由包作者决定,需用外部脚本或构建工具实现分离与部署。

如何在composer配置文件中指定中文文档的存放路径并自动解压

Composer 本身不支持“中文文档存放路径”或“自动解压文档”这类功能——它只负责下载、安装和自动加载 PHP 包,不处理文档提取、语言版本选择或静态资源分发。

composer.json 里没有文档路径配置项

你无法在 composer.json 的 config 或 extra 段里写类似 "docs-dir": "zh-CN" 这样的字段。Composer 不识别、不解析、也不执行任何与文档路径相关的逻辑。

  • config.vendor-dir 控制的是依赖包安装位置,不是文档
  • installer-paths(配合 composer/installers)只对声明了特定 type(如 drupal-module、wordpress-plugin)的包生效,且前提是包自己在 composer.json 中声明了该 type
  • 普通 library 包(比如 monolog/monolog)默认 type 是 library,不会被 installer-paths 规则匹配,更不会触发解压文档行为

所谓“中文文档”通常不在 Composer 包内

绝大多数开源 PHP 包的文档托管在 GitHub Wiki、ReadTheDocs、或项目根目录的 docs/、README.md 中,且极少提供多语言版本。即使有 zh_CN/ 目录,也属于源码一部分,会随包一起解压到 vendor/{vendor}/{package}/ 下——但这是包作者决定的,不是 Composer 配置出来的。

Pandas 配置文件报告生成器
Pandas 配置文件报告生成器

使用ydata-profiling(前身为pandas-profiling)生成全面的数据质量报告,包含相关性分析、缺失值模式和基数检测。导出交互式HTML仪表板和JSON摘要。

下载
  • Composer 安装时只解压包的 dist(zip/tar)或 source(git clone),不会额外提取子目录、过滤语言、或重写路径
  • 没有机制能告诉 Composer:“只取 docs/zh/,忽略 docs/en/”
  • 如果你看到某包声称“支持中文文档”,那大概率是它把 docs/ 当作普通文件包含进发布包,解压后自然存在,无需额外配置

真要实现文档分离或自动解压,得靠外部工具链

想把文档单独拎出来、按语言归类、甚至自动解压渲染,必须跳出 Composer 生态,用脚本或构建工具补位:

  • 用 post-install-cmd 或 post-update-cmd 脚本,在 composer install 后执行 cp -r vendor/foo/bar/docs/zh ./public/docs/foo/
  • 借助 make、npm run docs:copy 或 GitHub Actions 的 actions/checkout + rsync 拉取文档分支
  • 用静态站点生成器(如 Docsify、VuePress)从 vendor/ 动态读取 markdown,但需自行处理路径映射和语言路由
  • 如果包提供 .tar.gz 文档包(极少见),可写 shell 脚本下载+解压,但和 Composer 完全无关

真正容易被忽略的一点:很多人以为改了 vendor-dir 就能顺便管住文档路径,其实文档始终跟着包走;哪怕你把 vendor 搬到 third-party/,third-party/foo/bar/docs/ 还是原样存在——它只是被移动了位置,不是被“配置”出来的。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.25

344

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

543

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

307

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

349

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

300

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

443

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

251

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

310

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

360

26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习