9

我正在为某人创建一个网站，他们希望能够让该站点在某个 URL 获取 github 自述文件 Markdown 文件并将其显示在网站上，这样就不必在两个地方编写自述文件，它只是拉来自 github。那可能吗？我该怎么做？我看到了这个：

https://github.com/coreyti/showdown

这会将 Markdown 转换为 html，但我仍然不知道如何获取自述文件 URL 并将其转换为 showdown 可以解析的对象。

任何想法将不胜感激。

4

4 回答 4

5

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

注意：我是 StackEdit 的开发者

于 2013-04-26T11:33:01.387 回答
2

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

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

更新

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

于 2013-04-25T23:20:22.620 回答
0

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

于 2016-09-19T08:29:23.157 回答
0

我已经编写了riss.awk以在您的网站上插入 README.md，在此过程中可以选择执行一些转换。

能够让该站点获取 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 的任务可以每隔几个小时运行一次此过程以保持最新状态。

于 2021-09-23T07:56:06.077 回答