npm 包 pv-mavon-editor 使用教程

阅读时长 6 分钟读完

前言

pv-mavon-editor 是一个基于 Vue.js 的 Markdown 编辑器组件,它提供了多种功能,包括实时预览、导出文章等。本文将介绍如何使用该组件并提供一些示例代码。

安装

安装 pv-mavon-editor 有两种方式:

  1. 使用 npm 安装:在终端中执行以下命令:
  1. 直接下载:访问 https://github.com/wangfupeng1988/vue-markdown-editor 下载该组件的源代码。

使用

引入组件

使用 pv-mavon-editor 组件之前,需要在 Vue 模板中引入它:

-- -------------------- ---- -------
----------
  -----
    ------------- -------------------
  ------
-----------

--------
------ ----------- ---- -----------------
------ ------------------------------------

------ ------- -
  ----- --------------
  ----------- -
    -----------
  --
  ---- -- -
    ------ -
      -------- --
    -
  -
-
---------

-------
-- -- --
--------

传递选项

在使用 pv-mavon-editor 组件时,可以传入一些选项,定制化组件的外观和行为:

-- -------------------- ---- -------
----------
  -----
    -------------
      -----------------
      --------------
      --------------------
      ----------------
    --
  ------
-----------

--------
------ ----------- ---- -----------------
------ ------------------------------------

------ ------- -
  ----- --------------
  ----------- -
    -----------
  --
  ---- -- -
    ------ -
      -------- ---
      ------ -------- --------- ------------ ---------------- ------- ---------
      --------- -
        ----- ---
        ------- ---
        ---------- ---
        -------------- ---
        ----- ---
        ------ --
      -
    -
  -
-
---------

-------
-- -- --
--------

上述代码中,menus 属性表示菜单显示的顺序和类型,toolbars 属性表示工具栏的配置,canView 属性表示是否允许在编辑器中查看 Markdown 渲染后的效果,默认为 true

使用插件

pv-mavon-editor 组件支持使用多种插件,可以扩展组件的功能。例如,想使用代码高亮功能,可以引入 markdown-it-highlightjs 插件,并在组件的 extend 属性中传递该插件:

-- -------------------- ---- -------
----------
  -----
    -------------
      -----------------
      ----------------
    --
  ------
-----------

--------
------ ----------- ---- -----------------
------ --------------------- ---- -------------------------
------ ------------------------------------

------ ------- -
  ----- --------------
  ----------- -
    -----------
  --
  ---- -- -
    ------ -
      -------- ---
      ------- -
        -----------------------
      -
    -
  -
-
---------

-------
-- -- --
--------

其他功能

pv-mavon-editor 组件还提供了其他一些功能,比如:

  • getHtml():获取 Markdown 渲染后的 HTML 代码。
  • getText():获取 Markdown 原始文本。
  • insertText(text):在编辑器中插入文本。

示例代码:

-- -------------------- ---- -------
----------
  -----
    -------------
      ------------
      -----------------
    --
    ------- ---------------------- -------------
    ------- ----------------------------------
  ------
-----------

--------
------ ----------- ---- -----------------
------ ------------------------------------

------ ------- -
  ----- --------------
  ----------- -
    -----------
  --
  ---- -- -
    ------ -
      -------- --
    -
  --
  -------- -
    ---------- -- -
      ----- ---- - ---------------------------
      -----------------
    --
    ---------- -- -
      ------------------------------------------
    -
  -
-
---------

-------
-- -- --
--------

总结

本文介绍了如何使用 pv-mavon-editor 组件和一些常用的选项和插件,同时提供了一些示例代码和使用方法。希望本文对前端开发者们有所帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671d730d0927023822ce7

纠错
反馈