https://github.com/firede/msee

Msee is a command-line tool to read markdown file.
https://github.com/firede/msee

Last synced: 2 days ago
JSON representation

Msee is a command-line tool to read markdown file.

• Host: GitHub
• URL: https://github.com/firede/msee
• Owner: firede
• Created: 2013-05-23T13:39:02.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T17:47:38.000Z (about 2 years ago)
• Last Synced: 2024-12-16T22:13:18.732Z (9 days ago)
• Language: JavaScript
• Size: 470 KB
• Stars: 94
• Watchers: 5
• Forks: 18
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md

Awesome Lists containing this project

README

        
msee

===

[![NPM version](https://img.shields.io/npm/v/msee.svg?style=flat-square)](https://npmjs.org/package/msee)

[![Travis](https://img.shields.io/travis/firede/msee/master.svg?style=flat-square)](https://travis-ci.org/firede/msee)

[![Coveralls branch](https://img.shields.io/coveralls/firede/msee/master.svg?style=flat-square)](https://coveralls.io/github/firede/msee?branch=master)

[![Dependencies Status](https://img.shields.io/david/firede/msee.svg?style=flat-square)](https://david-dm.org/firede/msee)

[![download per month](https://img.shields.io/npm/dm/msee.svg?style=flat-square)](https://npmjs.org/package/msee)

[![License](https://img.shields.io/npm/l/msee.svg?style=flat-square)](https://npmjs.org/package/msee)

*msee* is a command-line tool to read markdown file.

And it's a library help your command-line software to output readable markdown content.

## Screenshot



## Installation

    $ npm install -g msee

## Usage

    msee 

    msee  | less

    cat  | msee

## API

```javascript

var msee = require('msee');

// parse markdown text

msee.parse('> hello world!');

// parse markdown file

msee.parseFile('~/doc/readme.md');

```

## Contributors

https://github.com/firede/msee/graphs/contributors

## License

MIT © [Firede](https://github.com/firede)

---

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/firede/msee/trend.png)](https://bitdeli.com/free "Bitdeli Badge")