Github markdown从存储库文件加载代码块

Question

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

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

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

如果res/data.json是同一代码库中的文件，该怎么做？我知道可以设置超链接，但我希望JSON数据直接出现在那里，而不需要点击超链接。

- takladev

Answer 1

我也在寻找一种方法来实现这个，虽然我同意Chris的分析，但你可以考虑使用github actions作为可能的解决办法：

https://github.com/marketplace/actions/markdown-embed-code-from-file

- Tom Hillman

Answer 2

使用GitHub Flavored Markdown无法实现此操作。

您可以通过编程方式更新README.md，然后提交生成的文件。最简单的解决方案可能是创建一个README-top.md，其中包含到```json为止的所有内容，以及一个README-bottom.md，其中包含```到文件结尾的所有内容。

然后，您只需执行类似以下的操作即可：

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

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

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

- Chris

---

pre-commit hook 是一个有趣的想法，但它是一个客户端工具，我不能期望项目中的每个人都在使用这些钩子（因为没有办法强制所有成员使用客户端钩子，即成员需要单独下载并安装客户端钩子）。 问题是我有多个用户贡献到 README 中，每个用户都有一个单独的文件中的 JSON，并且需要将该 JSON 包含在 README 中。我希望有一个可折叠的部分（在 Github 中使用 <details> 标签是可能的），并在该部分显示 JSON。 - takladev

那么我认为我们回到了我的答案的第一行：这在GFM中是不可能的。它不支持任何形式的逻辑，包括“包含”。这里是一个关于在GitHub的README.md文件中引用其他Markdown文件的类似问题。链接 - Chris