# vue-editable-markdown

> Click to Edit Textarea with markdown support

Latest version **0.2.1** (published 2020-05-31) · 0 weekly downloads

## Install

```sh
npm install vue-editable-markdown
pnpm add vue-editable-markdown
yarn add vue-editable-markdown
bun add vue-editable-markdown
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2020-05-31 |
| First published | 2020-05-24 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 30.9 KB |
| Known vulnerabilities | 0 (+22 in 2 direct dependencies) |
| Install scripts | no |
| Author | Yılmaz Çakmakçı |
| Maintainers | yilmazcakmakci |
| Keywords | markdown, click to edit, editable, textarea |

## Links

- npm: https://www.npmjs.com/package/vue-editable-markdown
- Homepage: https://github.com/yilmazcakmakci/vue-editable-markdown
- Issues: https://github.com/yilmazcakmakci/vue-editable-markdown/issues
- npm.io page: https://npm.io/package/vue-editable-markdown

## Dependencies (5)

- [marked](https://npm.io/package/marked.md) ^1.1.0
- [autosize](https://npm.io/package/autosize.md) ^4.0.2
- [dompurify](https://npm.io/package/dompurify.md) ^2.0.11
- [highlight.js](https://npm.io/package/highlight.js.md) ^10.0.3
- [github-markdown-css](https://npm.io/package/github-markdown-css.md) ^4.0.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.2.1 (latest) — 2020-05-31
- 0.1.3 — 2020-05-25
- 0.1.2 — 2020-05-25
- 0.1.1 — 2020-05-24
- 0.1.0 — 2020-05-24

## README

# vue-editable-markdown

![npm](https://img.shields.io/npm/dw/vue-editable-markdown)
![npm](https://img.shields.io/npm/v/vue-editable-markdown)

> Click to edit textarea with markdown support.

![Example](https://raw.githubusercontent.com/yilmazcakmakci/vue-editable-markdown/master/example.gif)

### Install

```shell
npm i vue-editable-markdown
```

### Usage

```javascript
<template>
  <editable-markdown mode="dark" :source="source" v-model="source" @blur="someFunction" />
</template>

<script>
import EditableMarkdown from "vue-editable-markdown"
export default {
  components: {
    EditableMarkdown
  },
  data () {
    return {
      source: "### Example"
    }
  },
  methods: {
    someFunction () {
      console.log("It's worked.")
    }
  }
}
</script>
```

### Features
* Dark/Light mode
* Markdown Support(table,syntax highlighting...)
* GitHub Flavored Markdown Style

### Props

| Prop   	| Options         	| Required 	| Default 	|
|--------	|-----------------	|----------	|---------	|
| mode   	| dark \| light   	| false    	| light   	|
| source 	| markdown string 	| false    	| empty string  |

### Event

@blur : Called when textarea blurred.

### Customization

You can override following classnames for changing components background color and of course you can also use DevTools to find classnames and editing them.

```css
.light.md-text-container {
    background-color: transparent !important; /* your favourite color */
}

.dark.md-text-container {
    background-color: #000 !important;  /* your favourite color */
}
```

---
_Source: https://npm.io/package/vue-editable-markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._