EASYMD

A simple cli for open markdown file

Why easymd ?

• Simple cli options
• Code highlight greate

Install

Run the following command in Terminal:

$ npm install -g easymd

Note: To run the preceding commands, Node.js and npm must be installed.

Usage

After you've installed easymd, you should be able to use the easymd program.

$ easymd --help

 Usage: easymd [options]

  Options:

    -h, --help            output usage information
    -V, --version         output the version number
    -f, --file <file>     create HTML file
    -b, --browser <file>  open markdown in browser

  Examples:

    $ easymd -b index.md
    $ easymd -f index.md /your/html/path/ 

The simplest use case would be opening the markdown file in the browser:

$ easymd -b README.md

On browser looks like this:

Easymd also can write html file:

$ easymd -f README.md

or

$ easymd -f README.md /your/output/path 

Running Tests & Contributing

$ git clone [email protected]:zhaoxingyue/easymd.git
$ npm install
$ npm test

Here are some important packages in the easymd ecosystem:

• marked - a markdown parser and compiler.
• highlight.js - javascript syntax highlighter.