是否存在用于渲染GitHub风格的Markdown的命令行实用程序？

我想知道是否存在用于获取GitHub风格的Markdown文件并将其呈现为HTML的命令行实用程序。

我正在使用GitHub Wiki创建网站内容。我已经在服务器上克隆了存储库，然后希望将其处理为常规HTML。对我来说重要的是，GitHub上显示的正是它应如何查找我的网站。我也很想将带围栏的块与~~~一起使用，所以我宁愿不只使用标准Markdown语法。

我研究了JavaScript实时预览，以为可以将其挂接到Node.js中，但他们说它已被弃用。我看过redcarpet信息库，但看起来好像没有命令行界面。

我提出了自己的解决方案，但是，由于这里没有任何一种解决方案明显比其他解决方案更好，因此我将在没有选择答案的情况下回答该问题。

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

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

使用标记的。它支持GitHub Flavored Markdown，可以用作Node.js模块并从命令行使用。

一个例子是：

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

也许这会有所帮助：

gem install github-markdown

没有文档，但是我是从gollum文档中获得的。查看rubydoc.info ，看起来您可以使用：

require 'github/markdown'  
puts GitHub::Markdown.render_gfm('your markdown string')

在您的Ruby代码中。您可以轻松地将其包装在脚本中，以将其转换为命令行实用程序：

#!/usr/bin/env ruby

# render.rb
require 'github/markdown'

puts GitHub::Markdown.render_gfm File.read(ARGV[0])

使用./render.rb path/to/my/markdown/file.md执行它。请注意，未经消毒在生产中使用不安全。

我用Python编写了一个小型CLI，并添加了GFM支持。它称为Grip（Github自述文件即时预览）。

通过以下方式安装：

$ pip install grip

要使用它，只需：

$ grip

然后访问localhost:5000以在该位置查看readme.md文件。

您还可以指定自己的文件：

$ grip CHANGES.md

并更改端口：

$ grip 8080

当然，当然也可以使用存储库上下文来专门呈现GitHub Flavorred Markdown：

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

显着特点：

希望这对这里的人有所帮助。看看吧。

我最近做了您想要的，因为我需要从Markdown文件生成文档，并且GitHub风格非常好。试试吧。它是用Node.js编写的。

来源：oschina

链接：https://my.oschina.net/stackoom/blog/3164140

标签