如何将jsdoc-to-markdown生成的MD文件关联到同仓库的Wiki

1. 克隆Wiki仓库到本地 #

GitHub仓库的Wiki是独立的Git仓库，执行以下命令克隆你的项目Wiki：
git clone https://github.com/ErrorBot1122/Roblox-File-Handler.wiki.git
克隆完成后本地会生成Roblox-File-Handler.wiki文件夹，所有Wiki页面文件都存在这个目录下。

2. 配置文档输出路径 #

修改你项目中jsdoc-to-markdown的生成配置，将输出路径指定到上述Wiki文件夹内。你可以直接在package.json中新增生成脚本，示例如下：

{
  "scripts": {
    "gen:docs": "jsdoc2md src/**/*.js > ../Roblox-File-Handler.wiki/API参考.md"
  }
}

注意调整命令中的路径和生成文件名，适配你本地两个仓库的相对位置，也可以拆分生成多份Markdown文件对应多个Wiki页面

3. 推送文档到Wiki #

每次执行脚本生成最新文档后，进入本地的Wiki文件夹，执行以下命令提交更新：

• git add .
• git commit -m "同步最新版本API文档"
• git push
  推送完成后刷新项目Wiki页面即可看到更新后的文档内容。

可选：配置自动同步 #

你可以配置GitHub Action实现代码推送到unstable分支时自动生成文档并同步到Wiki：

需先在项目仓库的Secrets中配置拥有仓库写入权限的GH_TOKEN
在项目目录下新增.github/workflows/sync-docs.yml文件，配置触发条件为unstable分支的push事件，执行流程依次为拉取项目代码、安装依赖、生成文档、克隆Wiki仓库、覆盖Wiki文件、推送Wiki更新即可。

内容的提问来源于stack exchange，提问作者Errorbot1122 THE SECOND