我想知道是否有一个命令行实用程序可以将GitHub风味Markdown文件并将其呈现为HTML。
我正在使用GitHub维基创建网站内容。我已经在服务器上克隆了存储库，然后想把它处理成常规HTML。对我来说，重要的是，在GitHub上出现的内容正是我的网站应该如何寻找的。我也非常喜欢使用带~~~的围栏块，所以我宁愿不使用标准Markdown语法。
我已经看了一下JavaScript的实时预览，我想我可以把它挂钩到Node.js，但他们说它已经被弃用了。我已经查看了红地毯存储库，但它看起来不像有命令行界面。
我选择了自己的解决方案，但是，由于这里没有一个解决方案明显比其他解决方案更好，所以我将不选择答案。
当前回答
在这条评论的基础上，我写了一个一行程序，使用curl和jq来访问Github Markdown API。
将这个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
如果你需要一个纯终端解决方案，用lynx“$HTMLFILE”替换打开的“$HTMLFILE”。
其他回答
我使用Pandoc选项——from=gfm为GitHub调味Markdown如下:
$ pandoc my_file.md --from=gfm -t html -o my_file.html
我最近做了你想要的东西，因为我需要从Markdown文件生成文档，GitHub风格非常好。试一试。它是用Node.js编写的。
gfm
这主要是@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处理器。
参见https://softwareengineering.stackexchange.com/a/128721/24257。
如果你对我们(Github)如何渲染Markdown文件感兴趣，你可能想看看Redcarpet，我们的Ruby接口到Sundown库。
Ruby-script，使用Redcarpet，将是“命令行工具”，如果你有本地Ruby
改进@barry- state的解决方案。将这段代码插入~/.bashrc中
function mdviewer(){
pandoc $* | lynx -stdin
}
然后，我们可以从命令行快速查看该文件。也可以很好地工作在SSH/Telnet会话。
mdviewer README.md
