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

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

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

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

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

当前回答

这主要是@barry- states对使用Pandoc的回答的后续。如果你用的是Mac电脑，Homebrew也有这个功能:

brew install pandoc

Pandoc通过markdown_github名称支持GFM作为输入格式。

输出到文件

cat foo.md | pandoc -f markdown_github > foo.html

在Lynx中打开

cat foo.md | pandoc -f markdown_github | lynx -stdin # To open in Lynx

在OS X的默认浏览器中打开

cat foo.md | pandoc -f markdown_github > foo.html && open foo.html # To open in the default browser on OS X`

TextMate软件集成

像大多数编辑器所允许的那样，您始终可以将当前选择或当前文档输送到上述其中一个。您还可以轻松地配置环境，以便pandoc替换Markdown包使用的默认Markdown处理器。

首先，创建一个包含以下内容的shell脚本(我将其命名为ghmarkdown):

#!/bin/bash
# Note included, optional --email-obfuscation arg
pandoc -f markdown_github --email-obfuscation=references

然后，您可以将TM_MARKDOWN变量(在Preferences→Variables中)设置为/path/to/ghmarkdown，它将替换默认的Markdown处理器。

其他回答

也许这可能会有所帮助:

gem install github-markdown

没有文档，但我从咕噜的文档里找到的。查看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路径/ /我/减价/ file.md。注意，在没有消毒的生产中使用是不安全的。

为此，我设法使用了一行Ruby脚本(尽管它必须放在单独的文件中)。首先，在每台客户端机器上运行这些命令一次，你将从下面的机器推送文档:

gem install github-markup
gem install commonmarker

接下来，在客户端镜像中安装这个脚本，并将其命名为render-readme-for-javadoc.rb:

require 'github/markup'

puts GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, File.read('README.md'))

最后，像这样调用它:

ruby ./render-readme-for-javadoc.rb >> project/src/main/javadoc/overview.html

ETA:这不会帮助你与stackoverflow风味Markdown，这似乎是失败的答案。

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

一个例子是:

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

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

pandoc README.md | lynx -stdin

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

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

安装:

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

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

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

推荐文章