zj-vditor
v1.0.1
Published
基于Vditor库的Markdown编辑器组件——Жидзин(Zidjin)系列组件库。
Downloads
12
Maintainers
Readme
Zj-Vditor MarkDown编辑器
基于Vditor库的Markdown编辑器组件——Жидзин(Zidjin)系列组件
安装
推荐使用npm的方式安装
npm install zj-vditor
引入
import ZjVditor from 'zj-vditor';
export default {
components: {
ZjVditor,
},
};
基本用法
初始化页面布局。
<template>
<zj-vditor :url="docUrl" />
</template>
<script>
export default {
components: {
ZjVditor: () => import('zj-vditor'),
},
data: () => ({
docUrl: "./xxx.md",
})
};
</script>
ZjVditor Attributes
| 参数 | 说明 | 类型 | 可选值 | 默认值 | | ---------------- | ------------------------------------------------------------ | ----------- | ------------------------------------------------------ | ------- | | value | MarkDown源文档内容 | string | — | — | | url | MarkDown源文档URL | string | — | — | | mode | 编辑模式 | string | sv 分屏预览, ir 即时渲染, wysiwyg 所见即所得 | wysiwyg | | theme | 主题 | object | classic, dark | classic | | placeholder | 文档占位文字 | string | — | — | | lang | 语言 | string | en_US, fr_FR, ja_JP, ko_KR, ru_RU, sv_SE, zh_CN, zh_TW | zh_CN | | tab | tab 键操作字符串,支持 \t 及任意字符串 | string | — | " " | | max-length | 最大字数,0则不限制 | number | — | 0 | | enable-cache | 启用缓存。是否使用 localStorage,实时缓存。TODO:需设计加载时检查,以免被新内容替换。 | boolean | true | false | | only-read | 只读模式 | boolean | true | false | | show-catelog | 是否显示目录大纲 | boolean | true | false | | catelog-position | 大纲位置 | string | left | right |
版本说明
V1.0.0.20230420-release
第一代稳定版本。未能有效加入锚点功能,未设计加载时检查缓存。