.md 文档中的表格包含在外部文件中

Question

有没有一种优雅的方法可以将外部文件中的表包含在 GitHub 呈现的 Markdown 文档中？

我能想到的不优雅的解决方案：

1. 将其作为图像包含（这个真的很难看）
2. 使用 Rmarkdown 并使用 R 打印表格（默认情况下不会渲染）

只是做一些解释。我在我的 git 存储库（由 GitHub 托管）中使用一组README.md文件，因此在线浏览存储库非常清晰，因为 GitHub 会自动渲染README.md每个子目录中的文件。

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

Answer 1

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

Github 支持的是基本的表格布局，你需要渲染它：

解决方案1：编写脚本

您可以将这样的内容添加到您的README.md：

<!-- TABLE_GENERATE_START -->

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

<!-- TABLE_GENERATE_END -->

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

解决方案2：pandoc

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

1. 使用csv2table将表重新格式化为 Markdown 文件table.md
2. 创建一个readme_header.mdandreadme_footer.md并在表格之前/之后添加 markdown
3. 将三个文件合并为cat readme_header.md table.md readme_footer.md > REAME.md

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