同一Git仓库内单个README.md文件关联方案咨询

你提到的submodule不适用，因为它是用来关联外部仓库的，哪怕是同一仓库，也会克隆完整仓库生成文件夹，不符合只关联单个文件的需求。以下是同一仓库内的可行方案：

1. 相对链接（仅跳转，不同步内容） #

如果只是需要在一个README里快速跳转到另一个，直接用Markdown相对链接即可，无需修改Git配置：

[查看子目录详细说明](./docs/subdir/README.md)

路径根据两个文件的实际层级调整，比如根目录README指向src/modules/core/README.md就写[核心模块说明](./src/modules/core/README.md)。

2. 符号链接（软链接，内容实时同步） #

如果需要两个文件内容完全一致，可创建软链接让目标文件指向源文件：

• Linux/macOS终端执行：

  ln -s ../../README.md docs/subdir/README.md
  

• Windows命令提示符（需管理员权限/开启开发者模式）执行：

  mklink docs\subdir\README.md ..\..\README.md
  

Git会直接跟踪软链接本身，克隆仓库后软链接会保留，系统会自动解析为指向源文件的路径。

3. Git内容过滤（自动同步内容） #

如果需要修改源文件时自动同步到目标文件，可通过Git的filter机制实现：

1. 在仓库根目录创建.gitattributes文件，添加：

   docs/subdir/README.md filter=readme-sync
   

2. 编辑仓库本地Git配置（.git/config），添加filter规则：

   [filter "readme-sync"]
       clean = cat README.md
       smudge = cat README.md
   

   这样每次提交或检出代码时，目标README会自动同步源README的内容。注意：团队成员需要同步配置这个filter，否则可能出现内容不一致。

4. 脚本+Git钩子（提交前自动同步） #

写一个简单的同步脚本，配合Git钩子实现提交前自动更新：

1. 创建sync-readme.sh脚本（Linux/macOS）：

   #!/bin/bash
   cp README.md docs/subdir/README.md
   

   Windows可创建sync-readme.bat：

   copy README.md docs\subdir\README.md
   

2. 将脚本加入pre-commit钩子：把脚本内容复制到.git/hooks/pre-commit，并赋予执行权限（Linux/macOS：chmod +x .git/hooks/pre-commit）。这样每次提交代码前，会自动同步两个文件的内容。

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