如何在网站上嵌入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来做到这一点