npm 包 gap-zjs-zmde 使用教程

介绍

gap-zjs-zmde 是一款用于在前端 web 应用中渲染 Markdown 文本的 npm 包。它提供了丰富的特性,如代码高亮、可嵌入图像、链接、表格等等。

在本文中,我们将介绍如何使用 gap-zjs-zmde 来渲染 Markdown 文本,并展示如何自定义样式和特性。

安装

gap-zjs-zmde 可以通过 npm 安装,只需输入以下命令:

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

使用

渲染 Markdown 文本非常简单,只需在 HTML 中加入一个 div 容器,然后使用 zMDE(blob) 方法来渲染:

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

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

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

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

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

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

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

渲染结果如下所示:

自定义主题

gap-zjs-zmde 支持自定义主题,你可以通过覆盖原有的 CSS 样式来改变渲染出来的 Markdown 文本外观。

以下是一个自定义主题的示例代码:

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

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

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

我们将这段 CSS 样式加入到我们的 HTML 页面中:

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

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

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

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

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

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

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

渲染结果如下所示:

自定义扩展

gap-zjs-zmde 还支持自定义扩展,你可以通过 zMDE.plugins 方法添加自己的渲染器。

以下是一个自定义扩展的示例代码:

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

我们将这段代码加入到我们的 HTML 页面中:

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

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

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

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

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

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

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

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

渲染结果如下所示:

总结

gap-zjs-zmde 是一款非常好用的 Markdown 渲染器,它易于使用并且支持自定义主题和扩展。我们在本文中介绍了如何使用它来渲染 Markdown 文本,如何自定义样式和特性。希望本文对你有所帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005629e81e8991b448dfca1


猜你喜欢

  • npm 包 eslint-config-gpsit-react 使用教程

    npm 包 eslint-config-gpsit-react 使用教程 介绍 npm 是一个使用非常方便的 JavaScript 包管理器,其中包括了大量的前端常用工具。

    3 年前
  • npm 包 stratic-indexes-to-rss 使用教程

    前言 随着前后端分离架构的流行,前端涉及的技术也越来越多,其中之一就是生成静态网站。静态网站生成器 Jekyll、Hexo 等相继出现,让生成静态网站变得易如反掌。

    3 年前
  • npm 包 math-array 使用教程

    在前端开发中,经常会需要进行数字运算。这时我们就需要用到一些数学库,而 npm 上的 math-array 包就是一个非常不错的选择。本文将介绍 math-array 包的使用方法,帮助你更好地进行前...

    3 年前
  • npm 包 test-ngx-toastr 使用教程

    今天,我想给大家介绍一个前端的 npm 包 test-ngx-toastr,它是一个非常实用的消息提示框组件,适用于 Angular 框架开发。本文将向大家详细讲解如何安装和使用该组件,以及一些常见问...

    3 年前
  • npm 包 hexo-theme-mip 使用教程

    Hexo 是一个快速、简洁且高效的静态博客框架,可以非常方便地生成静态网页,而且还支持大量主题。其中 hexo-theme-mip 是一个专门为移动设备优化的主题,配合外部的 mip html,可以进...

    3 年前
  • npm 包 insight-lite-ui 使用教程

    介绍 insight-lite-ui 是一款基于 Vue.js 开发的 UI 组件库。它提供了一系列易于使用的组件,帮助开发者快速构建美观、交互性强的 Web 应用界面。

    3 年前
  • npm 包 react-device-battery 使用教程

    当我们在开发前端网页或者 PWA 应用时,需要获取用户设备的电量信息。这时,我们可以使用 npm 包 react-device-battery。本文将详细介绍如何使用 react-device-bat...

    3 年前
  • npm 包 lesx-dsl-to-jsx 使用教程

    在前端开发中,我们经常会使用 DSL(Domain-Specific Language,领域特定语言)来描述应用程序中的数据和交互。尤其在 React Native 开发中,使用 DSL 技术能够更好...

    3 年前
  • npm 包 data-resolver 使用教程

    当我们在开发过程中需要处理异步数据时,可能会遇到一些问题,例如需要等待多个异步数据源返回结果后再进行下一步操作,或者需要对多个异步数据进行处理等。在这种情况下,我们可以使用 npm 包 data-re...

    3 年前
  • npm 包 handlebars-live-templates-idom 使用教程

    在前端开发中,我们经常需要使用模板引擎来动态生成 HTML 页面,而 Handlebars 是目前使用最广泛的一种模板引擎。而 handlebars-live-templates-idom 这个 np...

    3 年前
  • npm 包 starter-cli 使用教程

    在前端开发中,经常需要使用一些常见的工具、插件和框架,如何实现快速和方便的引用这些资源呢?这就需要用到 npm 包了。npm 是 Node.js 的包管理器,它拥有成千上万的开源包可以供我们引用使用。

    3 年前
  • npm 包 lesx-jsx 使用教程

    在前端开发中,我们经常需要使用到 JSX 语法,它可以让我们以一种更直观的方式编写组件,提高开发效率。然而,有时候我们需要在不支持 JSX 语法的环境下使用它,这时就需要使用 npm 包 lesx-j...

    3 年前
  • npm 包 vuex-async-actions 使用教程

    在 Vue.js 的项目中,我们经常需要使用 Vuex 这个状态管理插件来管理应用程序的状态。随着应用程序的复杂度增加,我们可能需要完成一些异步操作来获取数据,这时候就需要使用 Vuex-async-...

    3 年前
  • npm 包 Restal 使用教程

    在前端开发中,经常需要调用不同的 API,这时候使用 Restal 工具可以让 API 交互变得更加简单。Restal 是一个基于 Promise 的 API 客户端,它的功能非常全面,支持常见的 R...

    3 年前
  • npm 包 ymlib 使用教程

    前言 ymlib 是一款基于 yaml 格式的编程语言 YAML 的解析库,用于将 YAML 文本转换为 JavaScript 对象。本文将介绍如何在前端项目中使用该库,包括安装,使用方法和示例代码。

    3 年前
  • npm 包 ifour-db 使用教程

    如果你是一名前端开发者,那么你一定知道 npm。npm 是一个 JavaScript 包管理器,这个工具可以解决我们在开发中使用的各种依赖问题。在这里,我将要介绍一个 npm 包,其名称为 ifour...

    3 年前
  • 使用 handlebars-live-templates-generator-idom 快速构建前端应用

    当我们开发前端应用的时候,会发现重复性代码极其复杂,十分繁琐。此时,使用 handlebars-live-templates-generator-idom 这个 npm 包可以快速构建前端应用。

    3 年前
  • npm 包 changelog-md 使用教程

    随着项目越来越复杂,变更日志是一个必不可少的工具。而 changelog-md 就是一个非常好用的 npm 包,可以帮助我们很方便地生成符合标准的变更日志。 安装 可以通过 npm 命令安装: ---...

    3 年前
  • npm 包 multiline-control 使用教程

    当我们需要在一个输入框中输入多行文本时,普通的 input 不再适用。这时可以使用 textarea,但在一些情况下,我们需要限制输入框的行数和字符数量。这时候,我们可以使用 multiline-co...

    3 年前
  • npm 包 blazing 使用教程

    什么是 npm 包 blazing blazing 是一个牛逼的工具,用于将 Web 应用程序的打包大小减小到最小值,从而提高页面加载速度并优化用户体验。blazing 使用 webpack 和 ba...

    3 年前

相关推荐

    暂无文章