GitHub monorepo子包README.md符号链接配置问询

首先明确核心逻辑：你参考的仓库没有任何特殊的GitHub端配置，能实现子包直接展示根目录README的效果，本质就是用Git原生支持的仓库内相对路径符号链接，GitHub网页端对这类有效符号链接会直接解析渲染目标文件内容，不需要额外设置。

具体操作流程 #

1. 清理冗余文件 #

先删除所有子包目录下原本独立维护的readme.md文件，只保留仓库根目录下唯一需要长期维护的readme.md源文件。

2. 逐个子包目录创建符号链接 #

根据你当前的目录结构，每个子包的路径深度是两层（my_mono_repo/packages/[子包名]/），从子包目录回到仓库根目录需要向上跳转两级，对应的相对路径是../../readme.md，根据本地操作系统选择对应的创建命令：

• macOS、Linux 环境
  进入对应子包的根目录后执行：
  ln -s ../../readme.md readme.md
• Windows 环境（需要以管理员身份打开PowerShell或命令提示符）
  进入对应子包的根目录后执行：
  PowerShell 命令：
  New-Item -ItemType SymbolicLink -Path "readme.md" -Target "..\..\readme.md"
  CMD 命令：
  mklink readme.md ..\..\readme.md

3. 提交前校验 #

生成链接后先在本地检查Git是否正确识别为符号链接，避免提交无效的普通文本文件：
执行git ls-files -s 对应子包路径/readme.md，如果输出的文件模式位是120000，就说明Git正确识别了符号链接属性；如果模式位是普通文件的100644，就需要检查Git配置里的core.symlinks是否开启，开启命令为git config --global core.symlinks true，重新生成链接后再提交。

提交到远端仓库后，打开任意子包的目录页面，就能直接看到和参考效果一致的渲染内容，不需要额外在GitHub后台做任何配置。

常见踩坑提醒 #

• 绝对不要使用本地绝对路径生成符号链接，这类链接仅在你自己的设备上能正常解析，推到远端后其他协作者拉取代码、GitHub网页端都无法识别有效目标。
• 后续如果调整子包的目录层级，要同步修改符号链接对应的相对路径，避免出现死链。
• 删除旧的子包README文件后，最好先单独做一次提交，再生成并提交符号链接，避免Git对同路径的普通文件和符号链接产生识别混淆。

内容的提问来源于stack exchange，提问作者user9836706