как вставить файл github git README на веб-сайт

Question

Я делаю сайт для кого-то, и они хотят, чтобы этот сайт мог получить файл разметки github readme по определенному URL-адресу и отобразить его на веб-сайте, чтобы вместо того, чтобы писать readme в двух местах, он просто тянет от github. Это возможно? Как мне это сделать? Я видел это:

https://github.com/coreyti/showdown

который превращает уценки в HTML, но я до сих пор не так, как я бы принести ридй URL и преобразовать его в объект, который разборки могли разобрать.

Любые идеи были бы весьма признательны.

Answer 1

Вы можете использовать StackEdit. Он позволяет одновременно публиковать ваш документ по уценке в Github и других местах в Markdown или в формате HTML. Например, вы можете опубликовать HTML-код на общедоступном диске Google Диска или Dropbox.

ПРИМЕЧАНИЕ: Я разработчик StackEdit

Answer 2

GitHub имеет возможность отображать исходный файл, Raw кнопку в правом верхнем углу. Исходная ссылка для вашего примера: https://raw.github.com/coreyti/showdown/master/README.md

Предполагая, что файл README уже отформатирован в Markdown, вы можете просто извлечь источник и отформатировать его на своей стороне, библиотеки, скорее всего, уже существуют для вашего языка.

UPDATE

Я бы не на самом деле скачать файл с GitHub каждый раз, когда страница на сайте запрашиваются. GitHub может быть недоступен, соединение может быть медленным - и это повлияет на посетителей вашего сайта. Вместо этого вам может потребоваться выполнить задание cron на сервере, которое будет загружать файл из GitHub, скажем, каждые пять минут и кэшировать его локально. Затем каждый раз, когда вам нужно отображать файл, вы будете читать локальную копию и не зависеть от доступности сервера GitHub. В качестве недостатка вы будете иметь определенную задержку синхронизации (5 минут в моем примере).

Answer 3

Heroku, кажется, делает это путем копирования обработанную HTML https://elements.heroku.com/buildpacks/stouffi/heroku-i18n-js-buildpack-ruby#buildpack-instructions