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

how to embed a github git README file on a website

本文关键字：github git README 文件 网站      更新时间：2023-09-26

我正在为某人制作一个网站，他们希望能够让该网站在某个URL获取github自述文件并在网站上显示，这样就不必在两个地方编写自述文件，它只是从github拉。这可能吗?我该怎么做呢?我看到这个:

https://github.com/coreyti/showdown

将markdown转换为html，但我仍然不知道如何获取自述URL并将其转换为摊牌可以解析的对象。

任何想法都将非常感激。

您可以使用StackEdit。它允许您在Github和其他位置同时以markdown或HTML格式发布您的markdown文档。例如，你可以将HTML发布到公共Google Drive或Dropbox位置。

注意:我是StackEdit的开发人员

GitHub有一个选项来显示文件来源，Raw按钮在右上角。示例的原始链接为:https://raw.github.com/coreyti/showdown/master/README.md

假设README文件已经在Markdown中格式化了，你可以在你的语言中获取源代码并格式化它，库很可能已经存在了。

我实际上不会从GitHub下载文件，每次你的网站上的页面被请求。GitHub可能会关闭，连接可能会很慢——这将影响您的站点的访问者。相反，您可能希望在服务器上运行一个cron作业，例如每隔五分钟从GitHub下载一个文件，并将其缓存到本地。然后，每次需要显示文件时，您将读取本地副本，而不依赖于可访问的GitHub服务器。缺点是，您将有一定的同步延迟(在我的示例中为5分钟)。

Heroku似乎是通过复制呈现的html https://elements.heroku.com/buildpacks/stouffi/heroku-i18n-js-buildpack-ruby#buildpack-instructions

我写了riss。awk插入自述文件。在你的网站上，有选择地执行一些转换的过程。

能够让该站点获取github自述文件

您可以自动获取原始的README。Md文件如下:

curl https://raw.githubusercontent.com/cljoly/readme-in-static-site/main/README.md | awk -f riss.awk >readme-in-static-site.md

将其转换为一个对象，摊牌可以解析

我找不到摊牌的文档，但是可能有某种API可以用来上传上面生成的文件(readme-in-static-site.md)?然后，一个类似cronjob的任务可以每隔几个小时运行这个进程，以保持更新。

相关文章：