如何在網站上嵌入github git README文件

Question

我正在為某人建立一個網站，他們希望能夠讓該網站在某個URL上獲取github readme markdown文件並將其顯示在網站上，這樣就不必在兩個地方寫自述文件了來自github。 那可能嗎？ 我該怎么做？ 我看到了這個：

https://github.com/coreyti/showdown

這將markdown轉換為html，但我仍然不知道如何獲取自述文件URL並將其轉換為showdown可以解析的對象。

任何想法將不勝感激。

Answer 1

GitHub有一個顯示文件源的選項，右上角是Raw按鈕。 您的示例的原始鏈接是： https ： //raw.github.com/coreyti/showdown/master/README.md

假設README文件已經在Markdown格式化，您可以只獲取源並將其格式化，您的語言很可能已經存在庫。

UPDATE

每次請求您網站上的頁面時，我都不會從GitHub下載文件。 GitHub可能已關閉，連接速度可能會很慢 - 這會影響您網站的訪問者。 相反，您可能希望在服務器上運行一個cron作業，該程序將從GitHub下載文件，例如每五分鍾一次，並在本地緩存它。 然后，每次需要顯示文件時，您將讀取本地副本，而不依賴於可訪問的GitHub服務器。 作為一個缺點，您將有一定的同步延遲（在我的示例中為5分鍾）。

Answer 2

您可以使用StackEdit 。 它允許您以Markdown或HTML格式同時在Github和其他位置發布降價文檔。 例如，您可以在公共Google雲端硬盤或Dropbox位置發布HTML。

注意：我是StackEdit的開發人員

Answer 3

Heroku似乎通過復制渲染的html https://elements.heroku.com/buildpacks/stouffi/heroku-i18n-js-buildpack-ruby#buildpack-instructions來做到這一點