在前端开发中,我们经常需要制作流程图来帮助用户更好地理解业务流程。但是,手写流程图会比较繁琐且耗时。为了方便开发者快速绘制好看的流程图,我们介绍一个名为 blackst0ne-mermaid 的 npm 包。
什么是 blackst0ne-mermaid
blackst0ne-mermaid 是一个基于 Mermaid.js 的 npm 包,是一个流程图和图表的绘制工具。Mermaid.js 是一个用于在 Markdown 中定义图表和流程图的 JavaScript 库。
使用 blackst0ne-mermaid 可以快速绘制出各种流程图,包括简单流程、复杂流程、时序图、甘特图、类图、饼图等等,样式也可以自定义。
安装 blackst0ne-mermaid
在终端窗口中,执行以下命令进行 blackst0ne-mermaid 的安装:
- --- ------- -- ------------------
安装完成之后,我们就可以使用 blackst0ne-mermaid 来制作流程图了。
使用 blackst0ne-mermaid 制作流程图
- 创建一个 md 文件,例如
test.md
; - 在文件中加入以下代码:
--- ------- ----- --- ------ ------ ------ ------
-- ------- -- ----- -----
$ blackst0ne-mermaid test.md
-- ---------- ---- --------------- --------------------------------------------------------------------------------------------------------------- -----------------------
----- --- ------ ------ ------ ------
- --------- ------ - ------ ---- ------------------ - -------- --- - - - ------- - -------- --- - - - ------- - -------- --- - - - ------- - -------- --- - - - ------- -- ------ ------------------ ------------------------- ------- -------------------
----- -- ----- --- ---- ----- --- ----- -- ---- ---- ---- -- --- --- --- - -- --- -- --- - - --- - - --- - - --- ---- - --- ---- ----- ----- -------------------------------------- ----- ---- -------------------------------------- ----- - -------------------------------------- ----- - -------------------------------------- ----- - -------------------------------------- ----- - --------------------------------------
--------------- --------------------------------------------------------------------------------------------------------------- -- -- ---------- ------------------ -------- ------------------ ------------------------------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------