markdown-flow

声明方式

流程名称: # ABC 节点: ## ABC 代办项: - [ ] ABC 描述项: - ABC

# 流程名称

## 节点一

- [ ] 待办事项 1

## 节点二

- [ ] 待办事项 2
- [ ] 待办事项 3

流程标签

<metadata />

• 位于 # 流程声明下方为流程内容的容器标签
• 位于 ## 节点声明下方为节点内容的容器标签 (后文有详细使用)

<branches id="ABC" />

声明一个分支节点（节点内可包含多个分支）

• 仅能定义在流程的 <metadata /> 中
• id 为必填

<flow />

声明一个分支

• 仅能定义在 <branches /> 中

<start node="ABC" />

声明一个分支的开始节点（分支可包含多个开始节点）

• 仅能定义在 <flow /> 中
• node 为必填

<next node="ABC" />

声明当前节点的下一个节点（节点可包含多个下一步节点）

• 可定义在 <branches /> 与节点的 <metadata /> 中

node 有下面几种填写情况

因节点有从上至下的默认书写顺序，如节点（非分支节点）未包含任意 next，则自动将下一个 ## ABC 所表示的节点视为后续节点

1. 添加 ABC 为后续节点 <next node="ABC" />
2. 添加书写顺序的下一个节点为后续节点 <next />
3. 阻止默认的添加书写后序的行为 <next preventDefault />

<input name="ABC" />

HTML 中的 input，用于接收用户输入从而控制流程流转

• 目前仅能声明在流程节点的项中（需独占一行），如：

- [ ] 填写用户名和密码
      <input title="用户名" name="username" />
      <input name="password" type="password" />
- [ ] ...

• name 为必填，将在流程中导出同名变量，变量值即为用户输入的内容
• title 为可选，将设置为字段标题

<webhook title="ABC" url="https://www.makeflow.com" stage="done" once />

用于通知外部的

• 目前仅能声明在节点的 metadata 标签中：

## A

<metadata>
<webhook title="通知 Makeflow" url="https://www.makeflow.com" stage="done" once />
</metadata>

• url 为必填，将解析为请求发送地址
• title 为可选，增加 webhook 可读性
• stage 为可选，目前仅支持 done
• once 为可选，表示该 webhook 触发限制，once 为一次，默认为满足即触发

<variable name="ABC" expression={a}/>

用于产生变量输入从而控制流程流转

• 可声明在节点 <metadata /> 中
• name 为必填，将在流程中导出同名变量，变量值即为 expression 计算结果
• expression 的值支持 JavaScript 表达式，如：

<variable name="A" expression="66"/>
<variable name="B" expression={+A + 34}/>

<metadata id="ABC" enter={A === B} visible={B === C} />

节点的 metadata

• id 如不填默认值为二级标题内容，如 ## AAA 为 AAA
• enter 的值支持 JavaScript 表达式，表达式为假值时，流程将不执行节点以及节点的后续节点
• visible 的值支持 JavaScript 表达式，表达式为价值时，流程将跳过节点执行节点后续节点