是否有一个命令行实用程序来呈现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-Flavored Markdown,可选择存储库上下文:
$ grip --gfm --context=username/repo issue.md
显着特点:
stdin
读取并导出到3.0中添加的stdout
希望这可以帮助这里的人。 一探究竟。
我还没有找到GitHub-flavored Markdown的快捷方法,但我发现了一个稍微更通用的版本--Pandoc。 它从/转换成多种格式,包括Markdown,Rest,HTML和其他格式。
我还开发了一个Makefile
来将所有的.md文件转换为.html(大部分为写作,Markdown和Pandoc示例):
# 'Makefile'
MARKDOWN = pandoc --from markdown_github --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
。 请注意,这对于没有进行消毒处理的生产是不安全的。
上一篇: Is there a command line utility for rendering GitHub flavored Markdown?