实现Vue 的 markdown 文档可以在线运行（vue-markdown-run）

闲暇时间我用Vue框架写了一个博客，编辑器是用的markdown文本的形式，介绍性+描述完全能满足我的需求，但是，如果想在线运行我markdown文本中的Vue组件代码，则无法实现了，

于是我就自己写了一个组件，可以和普通文本显示器一样，显示文本，也可以执行Vue组件代码（只要标注vue-run）。

下面是介绍：

 

Github代码仓库

https://github.com/zhangKunUs...

 

在线运行

https://zhangkunusergit.githu...

 

我已经把我写的组件提交到npm中，可以引入并使用了，使用方式如下：

安装

npm install vue-markdown-run --save

 

用法：

（1）完整引入

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

（2）按需引入

借助 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
  }
}

 

组件的用法

 <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/stati... 中Styles
:runClass	非(String)	无	Vue运行代码处的css样式名称
:runStyle	非(Object)	无	Vue运行代码处的行间样式名称
@error	非(Function)	无	当前组件执行失败的回调函数

markdownTxt 写法要求

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

```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>

 

如有问题请联系

邮箱： 1766597067@qq.com