是否有一个命令行实用程序渲染GitHub风味Markdown?

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

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

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

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

当前回答

我用Python写了一个小的CLI，并添加了GFM支持。它叫做Grip (Github Readme即时预览)。

安装方法:

$ pip install grip

要使用它，简单地说:

$ grip

然后访问localhost:5000查看自述文件。Md文件在那个位置。

你也可以指定你自己的文件:

$ grip CHANGES.md

并更改端口:

$ grip 8080

当然，特别渲染github - flavour Markdown，可选的存储库上下文:

$ grip --gfm --context=username/repo issue.md

显著的特点:

渲染页面显示完全像在GitHub Fenced块 Python API 在2.0中添加的链接文件(谢谢vladwing!)之间导航导出到2.0中添加的单个文件(谢谢，iliggio! 新增:从stdin读取并导出到stdout

来看看。

其他回答

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

$ 奥尔马克发球 .

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

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

一个例子是:

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

pip3 install --user markdown
python3 -m markdown readme.md > readme.html

它不能处理GitHub扩展，但总比没有强。我相信您可以扩展模块来处理GitHub的添加。

我的最终解决方案是使用Python Markdown。我自己做了扩建，把栅栏块修好了。

阅读自述文件。md文件在终端我使用:

pandoc README.md | lynx -stdin

Pandoc以HTML格式输出，Lynx将其呈现在您的终端中。

它工作得很好:它充满了我的终端，快捷方式如下所示，我可以滚动浏览，链接也起作用了! 虽然只有一种字体大小，但颜色+缩进+对齐方式弥补了这一点。

安装:

Apt: sudo Apt -get install pandoc lynx Nix: Nix -shell -p pandoc lynx

推荐文章