Package Health Score

59 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.10.4	\|	12/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.9.1	\|	12/2020		0 C 0 H 1 M 0 L	0 H 0 M 0 L
1.7.7	\|	06/2017		0 C 0 H 3 M 0 L	0 H 0 M 0 L
1.6.7	\|	06/2017		0 C 0 H 3 M 0 L	0 H 0 M 0 L
1.5.9	\|	05/2017		0 C 0 H 3 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (5,026)

GitHub Stars: 6.46K
Forks: 918
Contributors: 40

Direct Usage Popularity

The npm package mavon-editor receives a total of 5,026 downloads a week. As such, we scored mavon-editor popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package mavon-editor, we found that it has been starred 6,456 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the mavon-editor repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like mavon-editor is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 354
Open PR: 14
Last Release: 3 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of mavon-editor based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for mavon-editor is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 8 years
Dependencies: 1 Direct
Versions: 183
Install Size: 3.98 MB
Dist-tags: 2
# of Files: 591
Maintainers: 7
TS Typings: Yes

mavon-editor has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

mavonEditor

Vue2
Vue3

English Documents

example (图片展示)

PC

> 查看更多图片点击这里...

Install mavon-editor (安装)

$ npm install mavon-editor@next --save

Use (如何引入)

index.js:

    // 全局注册
    // import with ES6
    import { createApp } from 'vue'
    import mavonEditor from 'mavon-editor'
    import 'mavon-editor/dist/css/index.css'
    // use
    createApp(App).use(mavonEditor).mount('#app')

index.html

<div id="app">
    
</div>

> 更多引入方式点击这里...

> 如何获取并设置markdown-it对象...

API 文档

props

name 名称	type 类型	default 默认值	describe 描述
value	String		初始值
language	String	zh-CN	语言选择，暂支持 zh-CN: 简体中文, zh-TW: 正体中文， en: 英文， fr: 法语， pt-BR: 葡萄牙语， ru: 俄语， de: 德语， ja: 日语
fontSize	String	14px	编辑区域文字大小
scrollStyle	Boolean	true	开启滚动条样式(暂时仅支持chrome)
boxShadow	Boolean	true	开启边框阴影
boxShadowStyle	String	0 2px 12px 0 rgba(0, 0, 0, 0.1)	边框阴影样式
transition	Boolean	true	是否开启过渡动画
toolbarsBackground	String	#ffffff	工具栏背景颜色
previewBackground	String	#fbfbfb	预览框背景颜色
subfield	Boolean	true	true：双栏(编辑预览同屏)， false：单栏(编辑预览分屏)
defaultOpen	String		在单栏（`subfield=false`）时默认展示区域. edit：默认展示编辑区域， preview：默认展示预览区域其他 = edit
placeholder	String	开始编辑...	输入框为空时默认提示文本
editable	Boolean	true	是否允许编辑
codeStyle	String	code-github	markdown样式：默认github, 可选配色方案
toolbarsFlag	Boolean	true	工具栏是否显示
navigation	Boolean	false	默认展示目录
shortCut	Boolean	true	是否启用快捷键
autofocus	Boolean	true	自动聚焦到文本框
ishljs	Boolean	true	代码高亮
imageFilter	function	null	图片过滤函数，参数为一个`File Object`，要求返回一个`Boolean`, `true`表示文件合法，`false`表示文件不合法
imageClick	function	null	图片点击事件，默认为预览，可覆盖
tabSize	Number	\t	tab转化为几个空格，默认为\t
html	Boolean	true	启用HTML标签，因为历史原因这个标记一直默认为true，但建议不使用HTML标签就关闭它，它能彻底杜绝安全问题。
xssOptions	Object	{}	xss规则配置, 默认开启，设置false可以关闭，开启后会对HTML标签进行过滤，默认过滤所有HTML标签属性，建议按需配置白名单减少被攻击的可能。 - 自定义规则参考: https://jsxss.com/zh/options.html - 参考DEMO: dev-demo
toolbars	Object	如下例	工具栏

toolbars

默认工具栏按钮全部开启, 传入自定义对象，可以选择启用部分按钮

 /*
    例如: {
        bold: true, // 粗体
        italic: true,// 斜体
        header: true,// 标题
    }
    此时, 仅仅显示此三个功能键
 */

toolbars: {
    bold: true, // 粗体
    italic: true, // 斜体
    header: true, // 标题
    underline: true, // 下划线
    strikethrough: true, // 中划线
    mark: true, // 标记
    superscript: true, // 上角标
    subscript: true, // 下角标
    quote: true, // 引用
    ol: true, // 有序列表
    ul: true, // 无序列表
    link: true, // 链接
    imagelink: true, // 图片链接
    code: true, // code
    table: true, // 表格
    fullscreen: true, // 全屏编辑
    readmodel: true, // 沉浸式阅读
    htmlcode: true, // 展示html源码
    help: true, // 帮助
    /* 1.3.5 */
    undo: true, // 上一步
    redo: true, // 下一步
    trash: true, // 清空
    save: true, // 保存（触发events中的save事件）
    /* 1.4.2 */
    navigation: true, // 导航目录
    /* 2.1.8 */
    alignleft: true, // 左对齐
    aligncenter: true, // 居中
    alignright: true, // 右对齐
    /* 2.2.1 */
    subfield: true, // 单双栏模式
    preview: true, // 预览
  }

如果需要自定义添加工具栏按钮，可以通过以下方式


  
  <template slot="left-toolbar-before">
    <button title="自定义" aria-hidden="true" class="op-icon fa fa-mavon-align-left" type="button"></button>
  </template>
  
  <template slot="left-toolbar-after">
    <button title="自定义" aria-hidden="true" class="op-icon fa fa-mavon-align-left" type="button"></button>
  </template>
  
  <template slot="right-toolbar-before">
    <button title="自定义" aria-hidden="true" class="op-icon fa fa-mavon-align-left" type="button"></button>
  </template>
  
  <template slot="right-toolbar-after">
    <button title="自定义" aria-hidden="true" class="op-icon fa fa-mavon-align-left" type="button"></button>
  </template>

events 事件绑定

name 方法名	params 参数	describe 描述
change	String: value , String: render	编辑区发生变化的回调事件(render: value 经过markdown解析后的结果)
save	String: value , String: render	ctrl + s 的回调事件(保存按键,同样触发该回调)
fullScreen	Boolean: status , String: value	切换全屏编辑的回调事件(boolean: 全屏开启状态)
readModel	Boolean: status , String: value	切换沉浸式阅读的回调事件(boolean: 阅读开启状态)
htmlCode	Boolean: status , String: value	查看html源码的回调事件(boolean: 源码开启状态)
subfieldToggle	Boolean: status , String: value	切换单双栏编辑的回调事件(boolean: 双栏开启状态)
previewToggle	Boolean: status , String: value	切换预览编辑的回调事件(boolean: 预览开启状态)
helpToggle	Boolean: status , String: value	查看帮助的回调事件(boolean: 帮助开启状态)
navigationToggle	Boolean: status , String: value	切换导航目录的回调事件(boolean: 导航开启状态)
imgAdd	Number: pos, File: imgfile	图片文件添加回调事件(pos: 图片在列表中的位置, File: File Object)
imgDel	Array(2):[Number: pos,File:imgfile ]	图片文件删除回调事件(Array(2): 两个元素的数组，第一位是图片在列表中的位置，第二位是File对象)

代码高亮

> 如不需要hightlight代码高亮显示，你应该设置ishljs为false

开启代码高亮props

    
 &nbsp; &nbsp;

为优化插件体积，从v2.4.2起以下文件将默认使用cdnjs外链:

highlight.js
github-markdown-css
katex(v2.4.7)

代码高亮highlight.js中的语言解析文件和代码高亮样式将在使用时按需加载. github-markdown-css和katex仅会在mounted时加载

Notice: 可选配色方案和支持的语言是从 highlight.js/9.12.0 导出的

> 不使用cdn，本地按需加载点击这里...

图片上传

<template>
    
</template>

> 图片上传详情点击这里...

注

默认大小样式为 min-height: 300px , min-width: 300px 可自行覆盖
基础z-index: 1500
仅用作展示可以设置props: toolbarsFlag: false , subfield: false, defaultOpen: "preview"

快捷键

key	keycode	功能
F8	119	开启/关闭导航
F9	120	预览/编辑切换
F10	121	开启/关闭全屏
F11	122	开启/关闭阅读模式
F12	123	单栏/双栏切换
TAB	9	缩进
CTRL + S	17 + 83	触发保存
CTRL + D	17 + 68	删除选中行
CTRL + Z	17 + 90	上一步
CTRL + Y	17 + 89	下一步
CTRL + BreakSpace	17 + 8	清空编辑
CTRL + B	17 + 66	加粗
CTRL + I	17 + 73	斜体
CTRL + H	17 + 72	# 标题
CTRL + 1	17 + 97 or 49	# 标题
CTRL + 2	17 + 98 or 50	## 标题
CTRL + 3	17 + 99 or 51	### 标题
CTRL + 4	17 + 100 or 52	#### 标题
CTRL + 5	17 + 101 or 53	##### 标题
CTRL + 6	17 + 102 or 54	###### 标题
CTRL + U	17 + 85	++下划线++
CTRL + M	17 + 77	==标记==
CTRL + Q	17 + 81	> 引用
CTRL + O	17 + 79	1. 有序列表
CTRL + L	17 + 76	[链接标题](链接地址)
CTRL + ALT + S	17 + 18 + 83	^上角标^
CTRL + ALT + U	17 + 18 + 85	- 无序列表
CTRL + ALT + C	17 + 18 + 67	``` 代码块
CTRL + ALT + L	17 + 18 + 76	![图片标题](图片链接)
CTRL + ALT + T	17 + 18 + 84	表格
CTRL + SHIFT + S	17 + 16 + 83	~下角标~
CTRL + SHIFT + D	17 + 16 + 68	~~中划线~~
CTRL + SHIFT + C	17 + 16 + 67	居中
CTRL + SHIFT + L	17 + 16 + 76	居左
CTRL + SHIFT + R	17 + 16 + 82	居右
SHIFT + TAB	16 + 9	取消缩进

Dependencies (依赖)

Markdown 语法拓展

update(更新内容)

更新日志

Collaborators(合作者)

License (证书)

mavonEditor is open source and released under the MIT License.

mavon-editor dependencies

xss

mavon-editor development dependencies

@vue/test-utils auto-textarea autoprefixer babel-core babel-eslint babel-jest babel-loader babel-plugin-transform-runtime babel-polyfill babel-preset-env babel-preset-stage-2 copy-webpack-plugin css-loader eslint eslint-config-standard eslint-plugin-html eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-standard extract-text-webpack-plugin file-loader github-markdown-css html-loader html-webpack-plugin identity-obj-proxy jest jest-raw-loader jest-serializer-vue katex keycode less less-loader markdown-it markdown-it-abbr markdown-it-container markdown-it-deflist markdown-it-emoji markdown-it-footnote markdown-it-for-inline markdown-it-highlightjs-external markdown-it-images-preview markdown-it-ins markdown-it-katex-external markdown-it-mark markdown-it-sub markdown-it-sup markdown-it-task-lists markdown-it-toc merges-utils npm-run-all optimize-css-assets-webpack-plugin postcss postcss-advanced-variables postcss-atroot postcss-color-function postcss-custom-media postcss-custom-properties postcss-custom-selectors postcss-extend postcss-loader postcss-media-minmax postcss-mixins postcss-nested postcss-nested-import postcss-nesting postcss-partial-import postcss-property-lookup postcss-selector-matches postcss-selector-not raw-loader style-loader stylus stylus-loader url-loader vue vue-jest vue-loader vue-style-loader vue-template-compiler webpack webpack-bundle-analyzer webpack-dev-server webpack-md5-hash

FAQs

What is mavon-editor?

Vue markdown editor. Visit Snyk Advisor to see a full health score report for mavon-editor, including popularity, security, maintenance & community analysis.

Is mavon-editor popular?

The npm package mavon-editor receives a total of 5,026 weekly downloads. As such, mavon-editor popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is mavon-editor well maintained?

We found indications that mavon-editor is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is mavon-editor safe to use?

The npm package mavon-editor was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 05:24 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP