1 Star 2 Fork 0

放羊娃 / layout-dynamic-ui

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
ld-doc.md 4.11 KB
一键复制 编辑 原始数据 按行查看 历史
放羊娃 提交于 2021-05-10 15:36 . Fix error

ld-doc 文档编写页面

目的

在书写web说明示例文档时,通常需要结合代码显示不同的效果,这是,需要一个轻量级,简单的文档模板去结合代码进行显示示例

可使用的key

标签关键字 补充
p
h1
h2
h3
slot (具名插槽)
tip tip|tip_p 主题色,tip_d 危险色,tip_w 警告色 tip_i 信息色 tip_s 成功色
html
css
javascript
dart
bash
sql
md|markdown markdown简单文档支持

示例

  <doc :doc="doc">
    <template v-slot:name="e">
      这是插槽获取到的数据<br />
      {{e}}</br>
      这里可以更具实际情况,结合代码去做示例说明
    </template>
  </doc>
//...
data() {
return {
  doc: [{
    h1: '1.安装',
    h2: 'npm安装',
    p: '推荐使用 npm 的方式安装,它能更好地和 webpack 打包工具配合使用。',
    shell: 'npm i layout-dynamic-ui',
    //插槽 插槽名称
    slot: 'custom',
  }, {
    p: '我们期望通过传入简单的数据参数,来控制显示布局,避免同样的重复构建相似的布局。我们甚至可以通过从数据库加载布局信息,来显示不同的表单结构,让开发只需要专注于结构,减少对布局的重复构建。',
  }, {
    tip: '我们期望通过传入简单的数据参数,来控制显示布局,避免同样的重复构建相似的布局。我们甚至可以通过从数据库加载布局信息,来显示不同的表单结构,让开发只需要专注于结构,减少对布局的重复构建。',
    tip_d: '我们期望通过传入简单的数据参数,来控制显示布局,避免同样的重复构建相似的布局。我们甚至可以通过从数据库加载布局信息,来显示不同的表单结构,让开发只需要专注于结构,减少对布局的重复构建。',
    tip_w: '我们期望通过传入简单的数据参数,来控制显示布局,避免同样的重复构建相似的布局。我们甚至可以通过从数据库加载布局信息,来显示不同的表单结构,让开发只需要专注于结构,减少对布局的重复构建。',
    tip_i: '我们期望通过传入简单的数据参数,来控制显示布局,避免同样的重复构建相似的布局。我们甚至可以通过从数据库加载布局信息,来显示不同的表单结构,让开发只需要专注于结构,减少对布局的重复构建。',
    tip_s: '我们期望通过传入简单的数据参数,来控制显示布局,避免同样的重复构建相似的布局。我们甚至可以通过从数据库加载布局信息,来显示不同的表单结构,让开发只需要专注于结构,减少对布局的重复构建。',
  },
  {
    code:{
      javascript:
        (`
  import import Vue from 'vue'
  import App from './App'
  import ElementUI from 'element-ui';
  import 'element-ui/lib/theme-chalk/index.css';

  import layoutDynamicUI from 'layout-dynamic-ui';
  import 'layout-dynamic-ui/lib/index.css';

  Vue.use(ElementUI);

  Vue.use(layoutDynamicUI);

  Vue.config.productionTip = false


  new Vue({
  el: '#app',
  components: { App },
  template: '<App/>'
  })`)
    }
  }]
}
}
//...

通过以上代码的简单示例,即可获取到下方的效果图

效果图

效果图

ld-doc 参数

ld-doc 只有简单几个参数

关键字 类型 解释 默认值 是否必须 说明
doc [String,Array,Object] 要解析的文档类型
show-outline Boolean 是否显示大纲 true
codeLanguages Array prismjs支持的类型 ["csharp", "html", "css", "javascript", "php", "dart", "bash", "shell", "sql"]
skin String 皮肤 light:浅色;dark:深色
aligns String 文档大纲位置 left:居左;right:居右;center:居中
docWidth String 文档内容的宽度 100% 可以为 100px等这种格式
MdAnchorLinkTarget String md文档中锚链接点击时打开方式 _self _blank,_self,_parent,_top,framename

Slot 插槽(作用域插槽)

插槽方式 类型 插槽入参 说明
自定名称 作用域插槽 根据传入的数据值定义不同的插槽
1
https://gitee.com/jpw_code/layout-dynamic-ui.git
git@gitee.com:jpw_code/layout-dynamic-ui.git
jpw_code
layout-dynamic-ui
layout-dynamic-ui
main

搜索帮助