| 1 | msee
|
| 2 | ===
|
| 3 |
|
| 4 | `msee` is a command-line tool to read markdown file.
|
| 5 |
|
| 6 | And it's a library help your command-line software to output readable markdown content.
|
| 7 |
|
| 8 | ## Usage
|
| 9 |
|
| 10 | msee <file> [file...]
|
| 11 | msee <file> [file...] | less
|
| 12 | cat <file> | msee
|
| 13 |
|
| 14 | ## API
|
| 15 |
|
| 16 | ```javascript
|
| 17 | var msee = require('msee');
|
| 18 |
|
| 19 | // parse markdown text
|
| 20 | msee.parse('> hello world!');
|
| 21 |
|
| 22 | // ...with options
|
| 23 | // @see https://github.com/firede/msee/blob/master/lib/msee.js#L9
|
| 24 | msee.parse(str, {
|
| 25 | collapseNewlines: false,
|
| 26 | width: 120
|
| 27 | });
|
| 28 |
|
| 29 | // parse markdown file
|
| 30 | msee.parseFile('~/doc/readme.md');
|
| 31 | ```
|