外部文件包含的 .md 文档中的 table

A table in .md document included from external file

有没有一种优雅的方法可以在 GitHub 呈现的降价文档中包含来自外部文件的 table?

我能想到的非优雅方案:

  1. 将其作为图片添加(这张真的很丑)
  2. 使用 Rmarkdown 并使用 R 打印 table(默认情况下不会呈现)

稍微解释一下。我在我的 git 存储库(由 GitHub 托管)中使用一组 README.md 文件,所以在线浏览 repo 真的很清楚,因为 GitHub 自动呈现 README.md 每个子目录中的文件。

我正在通过算法生成应包含在这些文档中的摘要 table。如果可以从外部文件读取 table 会更优雅,因为我不想编写将直接修改 README.md 文件的脚本。

无法在 markdown 中包含文件。因此,您需要一个 "preprocessing" 阶段来生成降价,然后显示在 Github 上(或使用普通降价工具呈现)。

Github 支持的是 a basic table layout,您需要渲染它:

解决方案 1:脚本

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

<!-- TABLE_GENERATE_START -->

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

<!-- TABLE_GENERATE_END -->

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

方案二:pandoc

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

  1. 使用 csv2table 将您 table 重新格式化为降价文件到 table.md
  2. 创建 readme_header.mdreadme_footer.md 与降价 before/after table
  3. 合并三个文件cat readme_header.md table.md readme_footer.md > REAME.md

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

合并