实现Vue的markdown文档可以在线运行的方法示例
程序员文章站
2022-12-14 13:36:45
markdown 文档中vue代码 可执行啦,而且可以边看边执行。这样就可以用markdown文档的形式,写自己的vue博客了, 可以方便介绍自己的原创组件,很酷的执行。...
markdown 文档中vue代码 可执行啦,而且可以边看边执行。这样就可以用markdown文档的形式,写自己的vue博客了, 可以方便介绍自己的原创组件,很酷的执行。
github
https://github.com/zhangkunusergit/vue-markdown-run
demo
安装
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)文件 详细请参考: 中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>
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。