开源项目 命令行工具:在浏览器预览 Markdown 文档

gingerhot for Beijing Ruby Brigade · 2018年06月12日 · 最后由 alixiaomiao 回复于 2018年06月26日 · 544 次阅读

先贴下 GitHub 地址:https://github.com/beijingrb/mdopen

简介

mdopen 是一个命令行工具,用来在浏览器中预览 Markdown 文档。如果你习惯使用 Markdown 编辑器编辑文档,那你可能不大需要这个工具。

该命令行更适合那些喜欢用 vim 等在终端窗口写 Markdown 文档的人。比如在项目下写 README 的时候。

其实之前有想写个这样的工具自用,后来发现已经有人用 Go 写了一个,预览页面使用 GitHub 的风格。用起来很好用,于是就想着移植到 Ruby,这样对于那些没有安装 Go 环境的 Rubyists 也能用啦。

安装

gem install mdopen

用法

mdopen <markdown_file_path>

如果没有给参数,或者给定的文件不存在,则会读取当前目录下的 README 或者 README.md 文件。如果你在项目目录下想预览 README 文档,直接运行 mdopen 即可。

共收到 6 条回复

这种工具,你用 Ruby 来写,反而麻烦了

虽然我用不上,但还是支持一下

Go 版本的不需要装环境啊 ~ 不过 那个 Go 版本的作者好像没有 release 编译好的文件,大概也是懒得弄了

huacnlee 回复

为啥说 Ruby 写会麻烦呢?觉得和 Go 的复杂程度差不多的啊。

但是对于有 Ruby 环境的人安装和使用起来就方便多了。

IChou 回复

即使 release 了二进制版本,你也需要手动下载放到可执行路径里,每次更新都要重复一遍。

如果使用 go get -u 或者 gem install 安装以及更新就是一条命令的事儿。

不支持实时预览还是很不方便

一般用的编辑器不都有Markdown预览插件的吗。

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册