github - 从外部文件中包含的 .md 文档中的表格

Question

有没有一种优雅的方法可以在 GitHub 渲染的 markdown 文档中包含来自外部文件的表格？

我能想到的非优雅解决方案:

1. 将它作为图像添加(这个真的很难看)
2. 使用 Rmarkdown 并使用 R 打印表格(默认情况下不会呈现)

只是给一点解释。我在我的 git 仓库(由 GitHub 托管)中使用了一组 README.md 文件，所以在线浏览 repo 真的很清楚，因为 GitHub 会自动呈现 README.md 每个子目录中的文件。

我正在通过算法生成应包含在这些文档中的汇总表。如果可以从外部文件中读取该表，那就更优雅了，因为我不想编写将直接修改 README.md 文件的脚本。

Answer 1

无法在 markdown 中包含文件。因此，您需要一个“预处理”阶段来生成 Markdown ，然后将其显示在 Github 上(或使用普通 Markdown 工具呈现)。

Github支持的是a basic table layout ，你需要渲染:

解决方案一:脚本

您可以将类似这样的内容添加到您的 README.md 中:

<!-- TABLE_GENERATE_START -->

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

<!-- TABLE_GENERATE_END -->

然后有一个脚本可以拉入外部表，重新格式化它以匹配 github 格式并将它放在两个评论之间。

方案二:pandoc

Pandoc 是一个文档转换器框架，具有许多可能的输入和输出。如果您想学习另一种工具，您可以

1. 使用 csv2table 将表格重新格式化为 Markdown 文件进入 table.md
2. 创建一个 readme_header.md 和 readme_footer.md，在表格之前/之后标记
3. 将这三个文件合并到 cat readme_header.md table.md readme_footer.md > REAME.md

当然，您也可以混合使用这两种解决方案，例如使用脚本生成 table.md 并使用 cat

合并