# vue-markdown-run

> vue-markdown-run

Latest version **1.1.41** (published 2019-01-02) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.41 |
| Published | 2019-01-02 |
| First published | 2018-12-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 6 |
| Unpacked size | 8 MB |
| Known vulnerabilities | 0 (+7 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 24 |
| Author | zhangkun |
| Maintainers | zhang123456 |

## Links

- npm: https://www.npmjs.com/package/vue-markdown-run
- Repository: https://github.com/zhangKunUserGit/vue-markdown-run
- Homepage: https://github.com/zhangKunUserGit/vue-markdown-run#readme
- Issues: https://github.com/zhangKunUserGit/vue-markdown-run/issues
- npm.io page: https://npm.io/package/vue-markdown-run

## Dependencies (6)

- [vue](https://npm.io/package/vue.md) ^2.5.2
- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [marked](https://npm.io/package/marked.md) ^0.5.1
- [highlight](https://npm.io/package/highlight.md) ^0.2.4
- [vue-router](https://npm.io/package/vue-router.md) ^3.0.1
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.13.1

## Recent versions

- 1.1.41 (latest) — 2019-01-02
- 1.1.4 — 2018-12-10
- 1.1.3 — 2018-12-10
- 1.1.2 — 2018-12-10
- 1.1.1 — 2018-12-10
- 1.1.0 — 2018-12-10
- 1.0.42 — 2018-12-03
- 1.0.41 — 2018-12-03
- 1.0.4 — 2018-12-03
- 1.0.3 — 2018-12-03
- 1.0.225 — 2018-12-03
- 1.0.224 — 2018-12-03
- 1.0.223 — 2018-12-03
- 1.0.222 — 2018-12-03
- 1.0.221 — 2018-12-03
- … 5 more at https://npm.io/package/vue-markdown-run/versions

## README

# 实现Vue 的 markdown 文档可以在线运行

> 一个vue组件，用于markdown 文档中Vue代码执行，可以边看边执行。

### DEMO

https://zhangkunusergit.github.io/vue-markdown-run/dist

### 安装

``` bash
npm install vue-markdown-run --save
```

### 用法
#### (1)完整引入

```javascript
// 引入
import MarkdownRun from 'vue-markdown-run';
// 全局注入
Vue.use(MarkdownRun);
```

#### (2)按需引入
借助 [babel-plugin-component](https://github.com/ElementUI/babel-plugin-component)，我们可以只引入需要的组件，以达到减小项目体积的目的。

首先，安装 babel-plugin-component：

```
npm install babel-plugin-component -save-dev
```

然后，将 .babelrc 修改为：

```
{
  "plugins": [
    [
      "component",
      {
        "libraryName": "vue-markdown-run",
        "styleLibraryName": "theme"
      }
    ]
  ]
}
```

接下来，如果你只需引入部分组件，写入以下内容：

```
import { MarkdownRun } from 'vue-markdown-run';

export default {
  components: {
    MarkdownRun
  }
}

```

### 组件的用法

```html
 <markdown-run
    :mark="markdownTxt"
    highlight-style-file-name="github"
    :runClass=""
    :runStyle=""
    @error=""
  />
```
### 参数说明

| 参数 | 值 | 默认值 | 说明 |
| ------ | ------ | ------ | ------ |
| :mark | 必传(String) | 无 | markdown文本字符串(具体要求请看下面的“markdownTxt 写法要求”) |
| :scope | 非(Object) | 无 | markdown文本中，引入的组件，如果不想全局引入，可以局部引入，用法请看上面的DEMO|
| highlight-style-file-name | 非(String) | 'github' | markdown代码部分样式文件名，此处是指定引入那种样式（css）文件 详细请参考：https://highlightjs.org/static/demo/ 中Styles |
| :runClass | 非(String) | 无 | Vue运行代码处的css样式名称 |
| :runStyle | 非(Object) | 无 | Vue运行代码处的行间样式名称 |
| @error | 非(Function) | 无 | 当前组件执行失败的回调函数 |

### markdownTxt 写法要求
代码中必须指定哪个组件是需要执行的，在上面写上*vue-run*, 否则认为是普通文本，不予执行。
vue-run 放在语言类型后面，需要空格，例如：

```html
```html vue-run
<template>
  <div @click="go">Hello, {{name}}! 你可以点击试试</div>
</template>

<script>
  export default {
    data() {
      return {
        name: 'Vue'
      }
    },
 methods: {
      go () {
        alert('点击弹出， 代码vue已执行');
      }
    }
  }
</script>
<style>
 div{
  background-color: red;
 }
</style>
```

### 静态DEMO
markdown 文本

![avatar](code.png)

vue-markdown-run 执行后

![avatar](preview.png)

### 如有问题请联系
###### 邮箱： 1766597067@qq.com
###### 微信号： 18625531739

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