npm 包 markdown-it-plot 使用教程

如果你是一名前端工程师并且经常使用 markdown 编写文档,那么你一定知道 markdown-it 这个带有插件扩展系统的 Markdown 解析器。今天我们将要介绍一个新的插件: markdown-it-plot,它可以帮助你在 markdown 中内嵌绘制图表,让你的文档更加视觉化。

一、安装

在使用 markdown-it-plot 之前,你需要确保你已经安装了 markdown-it。接着,你可以使用 npm 命令安装 markdown-it-plot:

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

二、使用

安装完成之后,你需要将 markdown-it-plot 插件引入到你的代码中,代码示例如下:

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

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

在上面的代码中,我们引入了 markdown-it 和 markdown-it-plot 两个 npm 包,并且使用 md.use(markdownItPlot) 将 markdown-it-plot 插件加入到 markdown-it 中。

接着,我们就可以在我们的 markdown 文档中使用 %% 符号进行绘图了。语法如下所示:

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

在上面的代码中,我们使用了 flowchart.js 的语法,绘制了一个简单的流程图。你可以根据你的所需更改语法以绘制不同类型的图表,如折线图,柱状图等等。绘制出来的效果如下所示:

三、示例代码

以下是一个完整的示例代码:

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

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

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

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

      -----------

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

      --------

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

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

在上面的代码中,我们引入了 markdown-it,markdown-it-plot 和 mermaid 这三个 npm 包,并且在 <script> 标签中使用 md.use(markdownItPlot) 将 markdown-it-plot 插件加入到 markdown-it 中。

在 markdown 文档中,我们使用 %% 符号进行绘图,并使用 ![](图片链接) 的语法在文档中插入图片。最后,我们使用 md.render(source) 将 markdown 文档渲染成 HTML,并将其插入到 <div> 元素中显示。

四、总结

markdown-it-plot 这个插件可以帮助我们在 markdown 文档中绘制图表,让文档更加视觉化,更加易读易懂。它支持多种类型的图表,并且语法简单易学,使用起来非常方便,非常适合前端开发者。希望本文能够帮助你更好地使用 markdown-it-plot。

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


猜你喜欢

  • npm 包 angular5-csv-pub 使用教程

    前言 在前端开发中,数据导出功能是必不可少的一部分。而使用 csv 格式进行数据导出是非常常见的一种方式。因此我们可以借助 angular5-csv-pub 这个 npm 包来实现方便快捷的数据导出功...

    4 年前
  • npm 包 md-links-pvp 使用教程

    在前端开发中,我们经常需要处理 markdown 文件,而其中可能包含大量的链接。为了方便检索和管理这些链接,我们可以使用 npm 包 md-links-pvp。本文将为大家详细讲解该包的使用教程。

    4 年前
  • NPM包xphoniex-bee-queue使用教程

    简介 xphoniex-bee-queue是一个基于Node.js的优秀的任务队列管理库。它可以轻松地跨多个进程/节点来管理大量的队列任务。 任务队列是应用程序最常见的一部分之一。

    4 年前
  • npm 包 core.io-pubsub-mqtt 使用教程

    在前端开发中,许多项目需要实现消息的订阅和发布功能。而 core.io-pubsub-mqtt 是一个基于 MQTT 协议实现的 npm 包,可以帮助开发人员简单地实现消息的订阅和发布功能。

    4 年前
  • npm 包 codemirror-wikidata 使用教程

    什么是 CodeMirror-wikidata CodeMirror-wikidata 是一个基于 CodeMirror 编辑器的扩展,可用于将 Wikidata 实体链接嵌入到文本编辑器中。

    4 年前
  • npm 包 vue-classify 使用教程

    前言 vue-classify 是一个基于 Vue.js 的插件,它提供了一种更加优雅和可维护的方式来组织和管理 Vue.js 的组件。它允许开发者将组件的逻辑和视图分离,并把逻辑部分转化为 Java...

    4 年前
  • npm 包 nemo-core 使用教程

    什么是 nemo-core? nemo-core 是一个基于 Node.js 和 Selenium WebDriver 的自动化测试框架,它支持在多个浏览器中进行测试,并提供了许多有价值的功能和工具,...

    4 年前
  • npm 包 cookies-eu-banner 使用教程

    随着网站和应用程序的发展,用户隐私和数据保护变得越来越重要。在欧盟,有一项法规(欧洲通用数据保护条例),要求网站必须获取用户同意才能使用他们的 Cookies。为了遵守这项法律,我们可以使用 cook...

    4 年前
  • npm 包 ember-mapbox-composer 使用教程

    今天,我们将分享一个名为 ember-mapbox-composer 的 npm 包,这是一个为构建使用 Mapbox GL 的大型应用程序而设计的组件库。 什么是 ember-mapbox-comp...

    4 年前
  • npm 包 robots-parse 的使用教程

    光是爬虫不够,还要智能化,而智能爬取,必然离不开 robots.txt 文件。npm 包 robots-parse 就是一款能够解析该文件的 Node.js 库,下面就为大家详细讲解一下该库的使用方法...

    4 年前
  • npm 包 mlemus-md-links 使用教程

    介绍 mlemus-md-links 是一个可以用来检查 Markdown 文件中的链接是否有效的 npm 包。它可以自动识别 Markdown 文件中的链接,并检查链接是否能够正常访问,并返回每个链...

    4 年前
  • npm 包 vue-capture 使用教程

    在前端开发过程中,我们经常需要对页面进行截图,以便于日后的调试和演示。而 vue-capture 是一款基于 Vue.js 和 HTML5 Canvas 的方便易用的截图组件库。

    4 年前
  • npm 包 proteus-js-core 使用教程

    介绍 proteus-js-core 是基于 TypeScript 编写的一款面向前端开发者的 npm 包,其主要功能是提供一组 JavaScript 工具函数和类,以优化和简化前端开发过程中的一些常...

    4 年前
  • npm 包 proteus-cli 使用教程

    Proteus-cli 是一个 npm 包,它可以帮助开发人员在项目管理、组合和快速原型验证方面提供更好的支持。在本文中,我们将介绍如何使用 proteus-cli 构建一个简单的 Web 应用程序。

    4 年前
  • npm 包 proteus-js-frames 使用教程

    简介 proteus-js-frames 是一个基于 React 的前端组件库,提供了各种常见的 UI 组件,如按钮、弹窗、表格、图表等。它使用了最新的 ES6、ES7 语法,应用 webpack 进...

    4 年前
  • npm 包 proteus-js-client 使用教程

    在 web 前端开发中,我们经常需要与后端服务器进行网络通信。proteus-js-client 是一个 npm 包,它提供了一种轻量级的网络通信方案,适用于 WebSocket 和 TCP 等协议。

    4 年前
  • npm 包 proteus-js-tracing 使用教程

    介绍 Proteus-js-tracing 是一款用于前端应用程序性能监控的 npm 包。它可以帮助前端开发者监控浏览器端网络和页面渲染性能,发现潜在的性能瓶颈,帮助开发者优化应用程序的性能。

    4 年前
  • npm 包 fs-toast 使用教程

    简介 在前端开发中,我们经常需要进行弹窗提示,以便向用户传达必要的信息。fs-toast 是一款基于 React 和 Antd 的 Toast 组件,可以快速实现弹窗提示功能,并提供了丰富的展示选项和...

    4 年前
  • npm 包 ts-runtime-reflection 使用教程

    在前端开发中,使用 TypeScript 可以提高代码的可读性、可维护性和健壮性。但是,使用 TypeScript 时需要手动添加类型注解,这使得代码的编写变得更加耗时和繁琐。

    4 年前
  • npm 包 insert-text-at-cursor 使用教程

    1. 简介 insert-text-at-cursor 是一款用于在前端 Web 应用中,将指定的文本插入到文本输入框(textarea)光标位置处的 npm 包。

    4 年前

相关推荐

    暂无文章