npm 包 mermal 使用教程

阅读时长 3 分钟读完

介绍

Mermal 是一个基于 markdown 语法的生成流程图和时序图的工具。它的运作方式主要是将 markdown 源代码转换为流程图或时序图的 JSON 描述,再由特定图形渲染引擎进行渲染。

Mermal 支持的语法和流程图或时序图模板十分丰富,使用方便,可设置参数动态改变图形样式,十分适用于前端开发、API 文档、技术博客等需求场景。

本篇文章将详细介绍 mermal 的使用教程,包括安装、常用语法、参数设置等内容,旨在帮助开发者进一步了解 mermal,快速掌握它的应用技巧。

安装

要使用 mermal 必须先安装 Node.js 和 npm。安装完成后,运行如下命令安装 mermal:

安装完成后,您可以在命令行界面输入 mermal -v,如果显示版本号则表示安装成功。

常用语法

流程图

流程图是一种图形化展示流程的方式,用于将一个任务或过程分解为一系列的步骤进行展示。Mermal 支持使用流程图语法绘制流程图。语法如下:

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

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

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

--- ---

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

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

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

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

-- ----

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

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

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

-- --

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

- ------------------------------------------------------------------------------ --------
------------------------------------------------------------------------------------------------------------------------
纠错
反馈