我想知道是否有一个命令行实用程序可以将GitHub风味Markdown文件并将其呈现为HTML。
我正在使用GitHub维基创建网站内容。我已经在服务器上克隆了存储库，然后想把它处理成常规HTML。对我来说，重要的是，在GitHub上出现的内容正是我的网站应该如何寻找的。我也非常喜欢使用带~~~的围栏块，所以我宁愿不使用标准Markdown语法。
我已经看了一下JavaScript的实时预览，我想我可以把它挂钩到Node.js，但他们说它已经被弃用了。我已经查看了红地毯存储库，但它看起来不像有命令行界面。
我选择了自己的解决方案，但是，由于这里没有一个解决方案明显比其他解决方案更好，所以我将不选择答案。
当前回答
为此，我设法使用了一行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，这似乎是失败的答案。
其他回答
一种“快速和肮脏”的方法是使用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条目页面及其所有依赖项。第二个将调用它的所有子页面。您现在可以通过打开Netflix/Hystrix/wiki.1.html浏览维基。
注意，对wget的两次调用都是必需的。如果您只运行第二个，那么您将错过正确显示页面所需的一些依赖项。
我使用Pandoc选项——from=gfm为GitHub调味Markdown如下:
$ pandoc my_file.md --from=gfm -t html -o my_file.html
在这条评论的基础上，我写了一个一行程序，使用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”。
我找到了一个网站，可以帮你做到这一点:http://tmpvar.com/markdown.html。粘贴你的Markdown，它会为你显示它。它似乎工作得很好!
然而，它似乎不能处理代码的语法高亮显示选项;也就是说，~~~ruby特性不起作用。它只打印‘ruby’。
改进@barry- state和@Sandeep的答案，为普通用户的elinks，你会添加以下到。bashrc:
function mdviewer() {
pandoc $* | elinks --force-html
}
不要忘记安装pandoc(和elinks)。
