1.0.2 • Published 5 years ago
vuepress-demo-plugin v1.0.2
vuepress-demo-plugin
安装
npm i vuepress-demo-plugin基础用法
// config.js
const demoPlugin = require('vuepress-demo-plugin')
..
module.exports = {
// ...
plugins: [
[demoPlugin, {
demoCodeMark = 'demo',
jsExtraStr = '',
htmlExtraStr = '',
pkg: {
dependencies: {
"vue": "2.5.17"
}
}
}]
// ...
],
}
// *.md
::: demo collapse descriptiion
<<< @/docs/.vuepress/components/collapse.vue
:::效果
::: demo collapse descriptiion <<< @/docs/.vuepress/components/collapse.vue :::
API
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| demoCodeMark | 自定义demo容器字段 | string | — | 'demo' |
| jsExtraStr | 添加在codesanbox中main.js 的字符串 | string | — | - |
| htmlExtraStr | 添加在codesanbox中index.html 的字符串 | string | — | - |
| pkg | 添加在codesanbox中依赖包 | string | — | - |
collapse-index 和@/docs/.vuepress/demoComponents/collapse/index.vue的格式保存一致
description 与下图的效果中的 description 一致，可以使用md的语法
