github-man

Open README from GitHub repository as a man page

Usage no npm install needed!

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

README

npm

github-man

Dependency Status

Open README from GitHub repository as a man page.

screenshot

CLI

github-man <user> <repo>

Opens readme for <user>/<repo> as a man page.

API

githubMan(user, repo, cb(err, man))

Fetches readme for <user>/<repo> from GitHub and renders it into a man page.

Related

  • npm-man — open any package readme from npm as a man page.
  • readman - display local package readme as a man page.

Install

npm install -g github-man

License

MIT