1.0.1 • Published 2 years ago

zj-vditor v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

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

参数说明类型可选值默认值
valueMarkDown源文档内容string
urlMarkDown源文档URLstring
mode编辑模式stringsv 分屏预览, ir 即时渲染, wysiwyg 所见即所得wysiwyg
theme主题objectclassic, darkclassic
placeholder文档占位文字string
lang语言stringen_US, fr_FR, ja_JP, ko_KR, ru_RU, sv_SE, zh_CN, zh_TWzh_CN
tabtab 键操作字符串,支持 \t 及任意字符串string" "
max-length最大字数,0则不限制number0
enable-cache启用缓存。是否使用 localStorage,实时缓存。TODO:需设计加载时检查,以免被新内容替换。booleantruefalse
only-read只读模式booleantruefalse
show-catelog是否显示目录大纲booleantruefalse
catelog-position大纲位置stringleftright

版本说明

V1.0.0.20230420-release

第一代稳定版本。未能有效加入锚点功能,未设计加载时检查缓存。