npm-man

Open any package readme from npm as a man page

Usage no npm install needed!

<script type="module">
  import npmMan from 'https://cdn.skypack.dev/npm-man';
</script>

README

npm

npm-man

Dependency Status

Fetches package's readme from the npm registry and renders it as a man page.

screenshot

CLI

npm-man <package>

Opens readme for <package> as a man page.

API

npmMan(packageName, cb(err, man))

Fetches readme for packageName from the npm registry and returns it as a man page.

Related

  • github-man — open README from GitHub repository as a man page.
  • readman - display local package readme as a man page.

Install

npm install -g npm-man

License

MIT