https://github.com/runvnc/modhelp
https://github.com/runvnc/modhelp
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/runvnc/modhelp
- Owner: runvnc
- Created: 2015-01-14T05:14:05.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-06-08T01:35:31.000Z (over 9 years ago)
- Last Synced: 2025-08-09T11:19:32.773Z (3 months ago)
- Language: JavaScript
- Size: 195 KB
- Stars: 23
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-nodejs-precise - modhelp - square)]() | Syntax-highlighted module READMEs in terminal with ANSI-friendly pager. | (Packages / Command-line apps)
- awesome-nodejs-cn - modhelp - 在终端动态高亮README模块。 (包 / 命令行应用)
README
# modhelp
Uses `marked-terminal` to render a README.md for any `npm` module in the terminal.
Now with built-in pager! Page up/down, arrow keys to scroll line-by-line, q to quit. I added this because piping to `less`, even with -r, doesn't work right with ANSI escape codes.
## Install
```sh
npm install -g modhelp
```
## Usage
```sh
modhelp themodule
```
[Tiny Villages: Horizontally Scaling Society](http://runvnc.github.io/tinyvillage)