/github-man

Open README from GitHub repository as a man page
  1. JavaScript 100.0%
JavaScript
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md
cli.js
index.js
package.json
screenshot.png

README.md

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