Command line documentation viewer for node js modules

Question

Is there a way to display the documentation of installed NodeJS packages in a console window (as a command line tool)? Often - in case of editing on a server - it is easier to view the docs of some specific stuff right in the command window, then to start a browser.

Such as npm docs fs or npm docs express would be perfect, but these try to start a browser and display documentation there instead of displaying README.md directly in the window.

Something similar to Perl's perldoc would be a perfect solution.

HNL · Accepted Answer · 2021-02-27 03:32:31Z

2

Here's what I do when I'm in a hurry:

# 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

answered Feb 27, 2021 at 3:32

HNL

5351 gold badge6 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Command line documentation viewer for node js modules

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related