如何将GitHub项目Wiki关联到项目内的docs文件夹

以下提供两种常用关联方案，可根据你的使用需求选择：

方案一：主项目内置docs为唯一内容源（推荐，普通克隆即可直接获取Wiki内容） #

该方案主项目的docs目录为唯一内容入口，用户克隆项目时无需额外操作即可拿到全部Wiki内容，GitHub侧的Wiki仅作为展示用的同步副本。

• 第一步：提交本地docs目录内容到主项目仓库
  进入Toto项目根目录，执行以下命令提交变更：

git add docs/
git commit -m "导入原Wiki全部内容到docs目录"
git push origin main

注：若你的主分支名称为master，请将上述命令中的main替换为master。

• 第二步：同步内容到GitHub Wiki仓库
  GitHub Wiki本身是独立的Git仓库，地址为你的项目地址后缀加.wiki.git，按以下操作同步：

1. 克隆项目对应的Wiki仓库到本地：

git clone https://github.com/你的GitHub用户名/Toto.wiki.git

2. 进入克隆得到的Toto.wiki目录，删除目录内所有原有文件，将主项目docs目录下的全部内容复制到当前目录
3. 提交变更到Wiki仓库：

git add .
git commit -m "同步主项目docs目录内容"
git push origin master

• （可选）配置自动同步
  你可以在主项目中添加GitHub Action工作流，实现每次提交docs目录变更后，自动同步内容到GitHub Wiki，无需手动操作。

方案二：绑定Wiki仓库为子模块（支持Wiki页面直接编辑后同步） #

该方案将GitHub Wiki仓库作为子模块绑定到项目的docs路径，支持用户直接在GitHub Wiki页面编辑内容，同步回主项目。

• 第一步：备份你本地Toto/docs目录下的所有内容，然后删除项目根目录下的docs文件夹
• 第二步：添加Wiki仓库为子模块到docs路径，执行以下命令：

git submodule add https://github.com/你的GitHub用户名/Toto.wiki.git docs

• 第三步：将备份的原有Wiki内容复制到docs目录，提交变更到子模块和主项目：

# 提交子模块（Wiki仓库）变更
cd docs
git add .
git commit -m "同步原有Wiki内容"
git push origin master
# 提交主项目子模块配置变更
cd ..
git add .gitmodules docs
git commit -m "绑定Wiki仓库为docs子模块"
git push origin main

注意：使用该方案时，用户克隆项目需要添加子模块拉取参数才能拿到docs内容，命令为：

git clone --recurse-submodules https://github.com/你的GitHub用户名/Toto.git

若用户已经克隆了项目，可执行以下命令拉取docs内容：

git submodule update --init --recursive

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