Github markdown 从 repo 文件加载代码块答案

【问题标题】：Github markdown load code block from a repo fileGithub markdown 从 repo 文件加载代码块
【发布时间】：2021-10-26 17:57:22
【问题描述】：

我想在我的README.md 中添加一个 JSON 代码块，并且该代码块需要从 repo 文件中加载。

例如，是否可以执行以下操作？

```json
<<load data from res/data.json>>
```

res/data.json 是同一个 repo 中的一个文件？我知道可以有一个超链接，但我希望 JSON 数据直接出现在那里而不点击超链接。

【问题讨论】：

【解决方案1】：

我也在寻找一种方法来做到这一点，虽然我同意 Chris 的分析，但您可能会将 github 操作视为一种可能的解决方法：

【讨论】：

【解决方案2】：

GitHub Flavored Markdown 无法做到这一点。

不过，您可以以编程方式更新您的README.md，然后提交生成的文件。最简单的解决方案可能是在文件末尾添加一个包含 ```json 之前的所有内容的 README-top.md 和一个包含 ``` 的 README-bottom.md。

然后你可以简单地做类似的事情

cat README-top.md res/data.json README-bottom.md > README.md

还有很多其他选项，包括相当复杂的模板工具。

pre-commit hook 可以让您进一步自动化此操作，每次您在本地提交时更新您的 README.md。

【讨论】：

预提交钩子是一个有趣的想法，但它是一个客户端工具，我不能指望项目中的每个人都使用这些钩子（因为没有办法强制执行客户端-所有成员的 -side 挂钩，即成员需要单独下载客户端挂钩并安装它）。问题是我有多个用户为自述文件做出贡献，每个用户都将他们的 JSON 放在一个单独的文件中，并且需要在自述文件中包含该 JSON。我希望有一个可折叠的部分（可以在 Github 中使用
标签）并在该部分中显示 JSON。
然后我想我们又回到了我的答案的第一行：这在 GFM 中是不可能的。它不支持任何类型的逻辑，包括“包含”。这是a similar question，关于在 GitHub README.md 中包含其他 Markdown 文件。