2017-01-23 93 views
1

如何在GitHub呈現的降價文檔中從外部文件中包含表格的優雅方式?從外部文件中包含的.md文件中的表格

我能想到的不優雅的解決方案:

  1. 它作爲圖像(這個人是真的很醜陋)
  2. 使用Rmarkdown和使用r打印表(不會被默認渲染)

只是給一點解釋。我在我的git倉庫(由GitHub託管)中使用了一組README.md文件,因此GitHub在每個子目錄中自動呈現README.md文件,因此在線瀏覽repo非常清楚。

我在算法上生成應包含在這些文檔中的彙總表。如果該表可以從外部文件讀取,那將會更加優雅,因爲我不想編寫將直接修改文件的腳本。

回答

2

無法在markdown中包含文件。所以你需要一個「預處理」階段來生成降價,然後在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 --> 

再有一個插入外部表格的腳本,將其重新格式化以匹配github格式,並將其放在兩個評論之間。

解決方案2:pandoc

Pandoc是許多可能的輸入和輸出的文檔轉換器框架。如果你參加學習另一種工具你可以

  1. 重新格式化您的表到使用csv2table減價文件到table.md
  2. 之前創建一個readme_header.mdreadme_footer.md與降價/表後
  3. 合併三文件與cat readme_header.md table.md readme_footer.md > REAME.md

當然,你也可以做兩種解決方案的混合,例如生成table.md使用腳本併合並使用cat

+0

這不完全是我想要的,因爲它需要執行另一個腳本。但是,使用makefile就不會那麼痛苦。我想我會嘗試一下。謝謝! –

+0

默認縮減格式不支持包含Markdown內的其他文件。現在,github有自己的減價風格(因爲有很多味道),但是這個[只直接支持表格,沒有包含文件](https://help.github.com/categories/writing -github /) – hansaplast

+0

@Slim:我添加了pandoc作爲答案的可能性 – hansaplast