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

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

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

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

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

我用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

显着特点：

• 渲染页面看起来与GitHub上的完全一样
• 围栏
• Python API
• 在2.0中添加的链接文件之间导航（谢谢，vladwing！）
• 导出到2.0中添加的单个文件（感谢iliggio！）
• 新增：在3.0中读取stdin和导出以stdout 添加

希望这对这里的人有所帮助。检查一下。

我还没有找到一种适用于GitHub风格的Markdown的快速简便的方法，但是我发现了一个稍微通用的版本-Pandoc。它可以与多种格式进行转换，包括Markdown，Rest，HTML等。

我还开发了一种Makefile将所有.md文件转换为.html的工具（大部分是Writing，Markdown和Pandoc的示例）：

# 'Makefile'
MARKDOWN = pandoc --from gfm --to html --standalone
all: $(patsubst %.md,%.html,$(wildcard *.md)) Makefile

clean:
    rm -f $(patsubst %.md,%.html,$(wildcard *.md))
    rm -f *.bak *~

%.html: %.md
    $(MARKDOWN) $< --output $@

也许这会有所帮助：

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。请注意，未经消毒在生产中使用不安全。

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

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

可能不是您想要的，但因为您提到了Node.js：在将它们提交到GitHub之前，我找不到在本地驱动器上预览GitHub Flavored Markdown文档的好工具，因此今天我基于Node.js创建了一个文档：https ：//github.com/ypocat/gfms

因此，如果您的问题仍然存在，也许您可​​以将其中的showdown.js重新用于Wiki。如果不是这样，也许其他与我一样面临同样问题的人会（和我一样）找到这个问题及其答案。

要在终端中读取README.md文件，请使用：

pandoc README.md | lynx -stdin

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

效果很好：它充满了我的终端，快捷方式如下所示，我可以滚动浏览，并且链接有效！ 虽然只有一种字体大小，但是颜色+缩进+对齐弥补了这一点。

安装：

sudo apt-get install pandoc lynx

GitHub有您可以使用的Markdown API。

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

一个例子是：

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

这主要是@ barry-staes使用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变量（在“首选项”→“变量”中）设置为/path/to/ghmarkdown，它将替换默认的Markdown处理器。

我创建了一个类似于Atom预览功能的工具，但它是一个独立的应用程序。不知道这是您要找的东西，但这可能会有所帮助。- https://github.com/yoshuawuyts/vmd

pandoc有browser适合我的作品。

用法： cat README.md | pandoc -f markdown_github | browser

安装（假设您使用的是Mac OSX）：

• $ brew install pandoc

• $ brew install browser

或在Debian / Ubuntu上： apt-get install pandoc browser

另请参阅https://softwareengineering.stackexchange.com/a/128721/24257。

如果您对[Github]渲染Markdown文件的方式感兴趣，则可能需要查看Redcarpet，这是我们与Sundown库的Ruby接口。

如果您拥有本地Ruby，则使用Redcarpet的 Ruby脚本将成为“命令行实用程序”

在此评论的基础上，我编写了一个代码行，使用和来访问Github Markdown API。curljq

将此bash函数粘贴到命令行或您的~/.bash_profile：

mdsee(){ 
    HTMLFILE="$(mktemp -u).html"
    cat "$1" | \
      jq --slurp --raw-input '{"text": "\(.)", "mode": "markdown"}' | \
      curl -s --data @- https://api.github.com/markdown > "$HTMLFILE"
    echo $HTMLFILE
    open "$HTMLFILE"
}

然后查看呈现的HTML浏览器内运行：

mdsee readme.md

如果需要纯终端解决方案，请替换open "$HTMLFILE"为lynx "$HTMLFILE"。

GitHub（自）开发了一个很好的模块化文本编辑器，称为Atom（基于Chromium，并使用Node.js模块进行打包）。

默认的预装软件包Markdown Preview可让您使用Ctrl+ Shift+ 在单独的选项卡中显示预览M。

我尚未测试其完整语法，但由于它来自GitHub，如果预览的语法与他们的语法不同（使用~~~工作的受限制的块），我会感到非常惊讶。

现在，虽然从技术上讲它不是基于命令行的，但它使用Node.js并将其输出到 DOM的渲染器，这可能会帮助任何尝试在基于Node.js的网络服务器上渲染基于GitHub语法的HTML的人，或者只是对其进行编辑/ hi README.md脱机。

我的最终解决方案是使用Python Markdown。我滚动了自己的 扩展程序，以固定栅栏块。

有一个非常好的和简单的工具可以浏览GFM Markdown文档：

GFMS-Github风味Markdown服务器

它简单，轻巧（无需配置），您可以在任何包含markdown文件的目录中启动以进行浏览的HTTP服务器。

特征：

• 全面的GFM Markdown支持
• 源代码语法突出显示
• 浏览文件和目录
• 美观的输出（以及可配置的CSS样式表）
• 导出为PDF

为此，我设法使用了单行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不会有帮助，在此答案上似乎失败了。

我将Pandoc与--from=gfmGitHub Flavored Markdown 的选项一起使用，如下所示：

$ pandoc my_file.md   --from=gfm -t html -o my_file.html

改进@ barry-stae的解决方案。将此代码段粘贴到〜/ .bashrc中

function mdviewer(){
  pandoc $* | lynx -stdin
}

然后，我们可以从命令行快速查看文件。通过SSH / Telnet会话也可以很好地工作。

mdviewer README.md

后期添加但showdownjs具有CLI工具，可用于将MD解析为HTML。

我找到了一个可以为您做到这一点的网站：http : //tmpvar.com/markdown.html。粘贴到Markdown中，它将为您显示。看来一切正常！

但是，它似乎没有处理代码的语法高亮选项；也就是说，该~~~ruby功能不起作用。它只是打印“红宝石”。

为elink普通用户改善@ barry-stae和@Sandeep答案，您可以在.bashrc中添加以下内容：

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

不要忘记安装pandoc（和elink）。

根据Jim Lim的回答，我安装了GitHub Markdown gem。其中包括一个名为gfm的脚本，该脚本在命令行中使用文件名并将等效的HTML写入标准输出。我稍作修改，将文件保存到磁盘，然后用launchy打开标准浏览器：

#!/usr/bin/env ruby

HELP = <<-help
  Usage: gfm [--readme | --plaintext] [<file>]
  Convert a GitHub-Flavored Markdown file to HTML and write to standard output.
  With no <file> or when <file> is '-', read Markdown source text from standard input.
  With `--readme`, the files are parsed like README.md files in GitHub.com. By default,
  the files are parsed with all the GFM extensions.
help

if ARGV.include?('--help')
  puts HELP
  exit 0
end

root = File.expand_path('../../', __FILE__)
$:.unshift File.expand_path('lib', root)

require 'github/markdown'
require 'tempfile'
require 'launchy'

mode = :gfm
mode = :markdown if ARGV.delete('--readme')
mode = :plaintext if ARGV.delete('--plaintext')

outputFilePath = File.join(Dir.tmpdir, File.basename(ARGF.path))  + ".html"

File.open(outputFilePath, "w") do |outputFile |
    outputFile.write(GitHub::Markdown.to_html(ARGF.read, mode))
end

outputFileUri = 'file:///' + outputFilePath

Launchy.open(outputFileUri)

“快速而肮脏”的方法是使用wget实用程序下载Wiki HTML页面，而不是克隆它。例如，这是我从GitHub下载Hystrix Wiki的方式（我正在使用Ubuntu Linux）：

 $ wget -e robots=off -nH -E -H -k -K -p https://github.com/Netflix/Hystrix/wiki
 $ wget -e robots=off -nH -E -H -k -K -I "Netflix/Hystrix/wiki" -r -l 1 https://github.com/Netflix/Hystrix/wiki

第一次调用将下载Wiki入口页面及其所有依赖项。第二个将调用其上的所有子页面。您现在可以通过打开来浏览Wiki Netflix/Hystrix/wiki.1.html。

请注意，这两个调用wget都是必需的。如果您仅运行第二个页面，那么您将错过正确显示页面所需的一些依赖项。

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

gfm