dam
v0.3.5
Published
Port of mad to node. Man for markdown
Downloads
17
Readme
dam(1)
Port of mad to node. Man for markdown.
Install
$ npm install -g dam
Usage
Read from stdin
$ cat README.md | dam
Pass file as argument
$ dam README.md
Pass a package name
$ dam npm
Skip the pager, pipe to stdout
$ dam --no-pager npm
When passing a package name, it will search the following:
- /node_modules//
- /usr/local/lib/node_modules//
If no readme is found, then it will show the first markdown file it finds. If no markdown files are found, then dam
will exit
Example
Credits
- TJ Holowaychuk for mad
- Domonic Tarr for default-pager
dam
uses a slightly modified version ofdefault-pager
TODO
- Fix nested list indentation
- Support color configuration
- Possibly render images to terminal (Not sure if less would support such a thing?)
- Add path configuration
Author
Evan Lucas
License
MIT (See LICENSE
for more info)