npm 包 hexo-filter-flowchart 使用教程

阅读时长 4 分钟读完

概述

hexo-filter-flowchart 是一个基于 flowchart.js 的 hexo 插件,用于在 markdown 中添加流程图。本文将详细介绍如何安装和使用该插件。

安装

前置条件

安装命令

使用 npm 命令进行安装:

使用

编写流程图

在 markdown 文件中添加以下代码:

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

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

其中,flowchartendflowchart 之间的内容为流程图的定义。其中使用了四个符号 =>, ->, yesno,分别表示:

  • =>: 定义一个元素,如 st=>start: Start
  • ->: 定义两个元素间的连接关系,如 st->op;
  • yesno: 表示连接关系的两个方向,如 cond(yes)->e 表示连接到 e 节点。

渲染流程图

在 hexo 博客中使用 hexo-filter-flowchart 插件将以上流程图进行渲染。具体步骤如下:

  1. 在 hexo 博客中的配置文件 source/_config.yml 中添加以下配置:

    这里 filter_plugins 表示使用的过滤器插件列表,hexo-filter-flowchart 表示要使用的插件名称。

  2. 在 hexo 博客的主题中添加 flowchart.js 的脚本和样式文件。以 next 主题为例,在主题配置文件 themes/next/_config.yml 中添加以下配置:

    这里通过 custom_csscustom_js 分别引入了 flowchart.min.cssjquery.min.jsflowchart.min.js 两个文件。

  3. 在博客预览或者发布后即可看到流程图的渲染效果。

示例代码

以下是一个完整的 markdown 文件,其中包含了一个含有四个节点的流程图:

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

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

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

-- ----

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

-- --

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

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