https://github.com/zhaoxingyue/easymd

open markdown in browser && conversion markdown into html
https://github.com/zhaoxingyue/easymd

cli highlight html markdown

Last synced: about 1 month ago
JSON representation

open markdown in browser && conversion markdown into html

• Host: GitHub
• URL: https://github.com/zhaoxingyue/easymd
• Owner: zhaoxingyue
• License: mit
• Created: 2017-04-12T02:16:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-20T09:57:17.000Z (over 4 years ago)
• Last Synced: 2024-10-02T15:06:27.926Z (about 2 months ago)
• Topics: cli, highlight, html, markdown
• Language: JavaScript
• Homepage: https://easymd-test1.now.sh
• Size: 14.6 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# EASYMD

A simple cli for open markdown file  

[![Build Status](https://travis-ci.org/zhaoxingyue/easymd.svg?branch=master)](https://travis-ci.org/zhaoxingyue/easymd)

[![Coverage Status](https://coveralls.io/repos/github/zhaoxingyue/easymd/badge.svg?branch=master)](https://coveralls.io/github/zhaoxingyue/easymd?branch=master)

[![Join the chat at https://gitter.im/easymd/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/easymd/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link)

[![Dependency Status](https://dependencyci.com/github/zhaoxingyue/easymd/badge)](https://dependencyci.com/github/zhaoxingyue/easymd)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)  

## 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      create HTML file

    -b, --browser   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](https://github.com/chjj/marked) - a markdown parser and compiler.

- [highlight.js](https://github.com/isagalaev/highlight.js) - javascript syntax highlighter.