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

Jacendfeng 发布于2019-08-23 13:59 / 1812人阅读

摘要：实现的文档可以在线运行一个组件，用于文档中代码执行，可以边看边执行。放在语言类型后面，需要空格，例如你可以点击试试点击弹出，代码已执行如有问题请联系邮箱微信号

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

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

Github

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

DEMO

https://zhangkunusergit.githu...

安装

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

组件的用法

参数说明

参数	值	默认值	说明
: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

如有问题请联系

邮箱： 1766597067@qq.com

微信号： 18625531739

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/99885.html

前端资源分享-只为更好前端

摘要：一团队组织网站说明腾讯团队腾讯前端团队，代表作品，致力于前端技术的研究腾讯社交用户体验设计，简称，腾讯设计团队网站腾讯用户研究与体验设计部百度前端研发部出品淘宝前端团队用技术为体验提供无限可能凹凸实验室京东用户体验设计部出品奇舞团奇虎旗下前一、团队组织网站说明腾讯 AlloyTeam 团队腾讯Web前端团队，代表作品WebQQ，致力于前端技术的研究 ISUX 腾...

zxhaaa 2019-08-22 16:11 评论0 收藏0
前端资源分享-只为更好前端

摘要：一团队组织网站说明腾讯团队腾讯前端团队，代表作品，致力于前端技术的研究腾讯社交用户体验设计，简称，腾讯设计团队网站腾讯用户研究与体验设计部百度前端研发部出品淘宝前端团队用技术为体验提供无限可能凹凸实验室京东用户体验设计部出品奇舞团奇虎旗下前一、团队组织网站说明腾讯 AlloyTeam 团队腾讯Web前端团队，代表作品WebQQ，致力于前端技术的研究 ISUX 腾...

JouyPub 2019-08-02 10:10 评论0 收藏0
前端资源分享-只为更好前端

摘要：一团队组织网站说明腾讯团队腾讯前端团队，代表作品，致力于前端技术的研究腾讯社交用户体验设计，简称，腾讯设计团队网站腾讯用户研究与体验设计部百度前端研发部出品淘宝前端团队用技术为体验提供无限可能凹凸实验室京东用户体验设计部出品奇舞团奇虎旗下前一、团队组织网站说明腾讯 AlloyTeam 团队腾讯Web前端团队，代表作品WebQQ，致力于前端技术的研究 ISUX 腾...

vslam 2019-08-30 15:53 评论0 收藏0
《HelloGitHub》第 68 期

摘要：在线尝试的进程管理工具。项目包含了代码实现运行过程动画以及相关论文为系统提供人脸识别解锁电脑的工具。在线阅读教科书计算机体系结构基础第三版。 .markdown-body{word-break:break-word;line-height:1.75;font-weight:400;font-size:15px;overflow-x:hidden;color:#333}.markdown-b...

番茄西红柿 2021-11-26 11:10 评论0 收藏2637