Skip to content
Branch: master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

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:

  • pwd/node_modules/package/readme
  • /usr/local/lib/node_modules/package/readme

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

Example

Credits

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)

About

Port of mad to node. Man for markdown

Resources

License

You can’t perform that action at this time.