<p align="center">
  <a href="https://vue-showdown.js.org" target="_blank">
    <img width="220" src="https://vue-showdown.js.org/logo.png" alt="Vue Showdown logo">
  </a>
</p>

<h1 align="center">
  Vue Showdown
</h1>

<p align="center">
  <a href="https://circleci.com/gh/meteorlxy/vue-showdown/tree/master" target="_blank">
    <img src="https://img.shields.io/circleci/project/github/meteorlxy/vue-showdown/master.svg?logo=circleci">
  </a>

  <a href="https://www.npmjs.com/package/vue-showdown" target="_blank">
    <img src="https://img.shields.io/npm/v/vue-showdown/latest.svg?logo=npm">
  </a>

  <a href="https://unpkg.com/vue-showdown/dist/vue-showdown.min.js" target="_blank">
    <img src="https://img.badgesize.io/meteorlxy/vue-showdown/master/dist/vue-showdown.min.js.svg?label=min%20size">
  </a>

  <a href="https://unpkg.com/vue-showdown/dist/vue-showdown.min.js" target="_blank">
    <img src="https://img.badgesize.io/meteorlxy/vue-showdown/master/dist/vue-showdown.min.js.svg?compression=gzip">
  </a>

  <a href="./LICENSE">
    <img src="https://img.shields.io/github/license/meteorlxy/vue-showdown.svg">
  </a>
</p>

## Introduction

Use [showdown](https://github.com/showdownjs/showdown) as a Vue component

## Usage

See [__Live Demo and Docs__](https://vue-showdown.js.org)

## Contributing

Feel free to submit Issues and PRs if you meet any problems or have any ideas.

### Develop

```sh
# Clone this repo
git clone https://github.com/meteorlxy/vue-showdown
cd vue-showdown
# Install dependencies (suggest to use Yarn, while NPM is OK, too)
yarn
# Start the dev-server
yarn dev
```
