是否有一种优雅的方法如何在GitHub呈现的降价文档中包含外部文件中的表?
我能想到的非优雅的解决方案:
只是给出一些解释。我在我的git存储库中使用了一组README.md
文件(由GitHub托管),因此在线浏览repo非常清楚,因为GitHub会在每个子目录中自动呈现README.md
文件。
我在算法上生成应包含在这些文档中的汇总表。如果可以从外部文件中读取该表,那将更加优雅,因为我不想编写将直接修改README.md
文件的脚本。
答案 0 :(得分:2)
无法在markdown中包含文件。所以你需要一个"预处理"生成降价的阶段,然后在Github上显示(或用正常的降价工具渲染)。
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是一个文档转换器框架,具有许多可能的输入和输出。如果您正在学习另一种工具,那么
table.md
readme_header.md
和readme_footer.md
cat readme_header.md table.md readme_footer.md > REAME.md
当然,您也可以混合使用两种解决方案,例如:使用脚本生成table.md
并使用cat