节点js模块的命令行文档查看器

时间:2016-12-28 21:24:28

标签: node.js command-line module documentation

有没有办法在控制台窗口(作为命令行工具)中显示已安装的NodeJS软件包的文档?通常 - 如果在服务器上进行编辑 - 在命令窗口中查看某些特定内容的文档会更容易,然后启动浏览器。

例如npm docs fsnpm docs express会很完美,但是这些会尝试启动浏览器并在那里显示文档,而不是直接在窗口中显示README.md

类似于Perl perldoc的东西将是一个完美的解决方案。

1 个答案:

答案 0 :(得分:1)

当我匆忙时,我会这样做:

# nodedoc
# USAGE: nodedoc <name of module>
# e.g. nodedoc http

curl https://raw.githubusercontent.com/nodejs/node/master/doc/api/$1.md | pandoc --from markdown --to plain | less