精华 更新 open-doc: npm包文档快速查看工具,方便大家使用
发布于 10 年前 作者 douguohui 5692 次浏览 最后一次编辑是 8 年前 来自 分享

安装

npm install -g open-doc

使用

比如想查看express的官方文档

open-doc express

如果要查看express 在github.com上的文档

open-doc express --github 或者 open-doc express -g

如果要查看express 在npmjs.org上的文档

open-doc express --npm 或者 open-doc express -n

项目地址

open-doc

open-doc.gif

更新

  • 考虑官方网站不存在或者为不合理的url的情况
  • 加入spin效果
  • 加入更多选择参数
12 回复

用了一下,挺方便的,赞

之前用过一个在terminal下使用的文档查看工具 nd,不过觉得在浏览器查看文档方便些,就干脆写了个:)

请问有哪些 文档可以查看?

把代码也发出来呗

@huzhongchun npm的扩展的相关文档都可以通过浏览器打开啊。这个工具的基本思路是通过npm的接口查到目标扩展的homepage,然后用浏览器打开。

@Dengshen 代码是开源的,都放在了 http://github.com/seandou/open-doc

更新了几点:

  • 考虑官方网站不存在或者为不合理的url的情况
  • 加入spin效果

大家可以 npm install -g open-doc 更新这个工具

更新:加了新参数。

比如 open-doc express 默认打开官方注册的文档,但我想看npmjs这个包的下载量或是github上包的关注度怎么办呢?

可以通过参数 --github(-g) 或者 --npm(-n) 快速打开 github.com 或者 npmjs.com 上的网址,即 open-doc express -g 或者 open-doc express -n

有意思有意思

最近一年更多在研究docker,今天看到消息node9都release了,感叹社区真是活跃,有点跟不上的焦虑感。 open-doc这个工具几年前写的,现在还有人在用,发现依赖的包接口都有变化,赶紧把bug fix掉舒缓一下心中的焦虑:)

回到顶部