我想知道是否有一个命令行实用程序可以将GitHub风味Markdown文件并将其呈现为HTML。

我正在使用GitHub维基创建网站内容。我已经在服务器上克隆了存储库,然后想把它处理成常规HTML。对我来说,重要的是,在GitHub上出现的内容正是我的网站应该如何寻找的。我也非常喜欢使用带~~~的围栏块,所以我宁愿不使用标准Markdown语法。

我已经看了一下JavaScript的实时预览,我想我可以把它挂钩到Node.js,但他们说它已经被弃用了。我已经查看了红地毯存储库,但它看起来不像有命令行界面。

我选择了自己的解决方案,但是,由于这里没有一个解决方案明显比其他解决方案更好,所以我将不选择答案。


当前回答

使用标记。它支持GitHub调味Markdown,可以作为Node.js模块和从命令行使用。

一个例子是:

$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

其他回答

GitHub有一个Markdown API,你可以使用。

可能不是你想要的,但既然你提到了Node.js:我找不到一个好工具在提交到GitHub之前在我的本地驱动器上预览GitHub调味Markdown文档,所以今天我创建了一个基于Node.js的文档:https://github.com/ypocat/gfms

因此,如果您的问题仍然是实际的,也许您可以在您的Wiki中重用其中的showdown.js。如果不是这样,也许其他和我面临同样问题的人会发现(就像我一样)这个问题和这个答案。

参见https://softwareengineering.stackexchange.com/a/128721/24257。


如果你对我们(Github)如何渲染Markdown文件感兴趣,你可能想看看Redcarpet,我们的Ruby接口到Sundown库。

Ruby-script,使用Redcarpet,将是“命令行工具”,如果你有本地Ruby

另一个选择是AllMark -降价服务器。 Docker映像可用于准备就绪的设置。

$ 奥尔马克发球 .

注意:它递归扫描目录服务网站从markdown文件。因此,为了更快地处理单个文件,请将其移动到单独的目录。

改进@barry- state和@Sandeep的答案,为普通用户的elinks,你会添加以下到。bashrc:

function mdviewer() {
  pandoc $* | elinks --force-html
}

不要忘记安装pandoc(和elinks)。