vue-showdown/README.md

Use showdown as a vue component

<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://app.netlify.com/sites/vue-showdown/deploys" target="_blank">
    <img src="https://api.netlify.com/api/v1/badges/38bbf932-4e25-4e84-87e1-8457c96739c6/deploy-status">
  </a>

  <a href="https://github.com/meteorlxy/vue-showdown/actions?query=workflow%3Acheck" target="_blank">
    <img src="https://github.com/meteorlxy/vue-showdown/workflows/check/badge.svg">
  </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/main/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/main/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>

> Current branch is for Vue 3 only. If you are using Vue 2, please check out [v2 branch](https://github.com/meteorlxy/vue-showdown/tree/v2).

## 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
pnpm i

# Start the dev-server
pnpm dev
```

## LICENSE

[MIT](https://github.com/meteorlxy/vue-showdown/blob/master/LICENSE) &copy; [@meteorlxy](https://github.com/meteorlxy) & [Contributors](https://github.com/meteorlxy/vue-showdown/graphs/contributors)