我想知道是否有一个命令行实用程序可以将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”。
其他回答
我最近做了你想要的东西，因为我需要从Markdown文件生成文档，GitHub风格非常好。试一试。它是用Node.js编写的。
gfm
改进@barry- state的解决方案。将这段代码插入~/.bashrc中
function mdviewer(){
pandoc $* | lynx -stdin
}
然后，我们可以从命令行快速查看该文件。也可以很好地工作在SSH/Telnet会话。
mdviewer README.md
也许这可能会有所帮助:
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。注意，在没有消毒的生产中使用是不安全的。
带浏览器的Pandoc对我来说很好。
用法:cat README。Md | pandoc -f markdown_github |浏览器
安装(假设你使用的是Mac OSX):
安装pandoc $ brew安装浏览器
Debian/Ubuntu: apt-get安装pandoc浏览器
GitHub(从那时起)开发了一个很好的模块化文本编辑器Atom(基于Chromium，并使用Node.js模块作为包)。
一个默认的预安装包Markdown预览让您显示您的预览在一个单独的选项卡使用Ctrl + Shift + M。
我还没有测试它的完整语法，但由于它来自GitHub，如果预览的语法与他们的不同(使用~~~工作的栅栏块)，我会非常惊讶。
现在，虽然它在技术上不是基于命令行，但它使用Node.js并输出到基于dom的渲染器，这可能会帮助任何试图在基于Node.js的web服务器上渲染基于GitHub语法的HTML的人，或者只是编辑她/他的README。md离线。
