diff --git a/guide/custom-node.md b/guide/custom-node.md
index dd98a03eac1d0b0abbab87caa7b935c48a4477f9..a44f43cc08bfa5be209c966c1477c911a0693dbe 100644
--- a/guide/custom-node.md
+++ b/guide/custom-node.md
@@ -1,21 +1,23 @@
# 自定义节点
-当节点库中的节点定义不满足场景需求时,用户可以通过自定义节点满足使用需求。
-用户可通过以下步骤创建自定义节点:
-1. 创建自定义节点
-2. 上传自定义节点到节点库
-3. 内置输入参数
+当节点库中的节点定义不满足场景需求时,用户可以通过自定义节点满足使用需求。
+用户可通过以下步骤创建自定义节点:
+1. 创建自定义节点
+2. 上传自定义节点到节点库
+3. 内置输入参数
### 1. 如何创建自定义节点
用户可以在[建木节点库](https://hub.jianmu.dev)创建节点,来实现节点的自定义。
+
1. 登录后点击头像进入个人主页,点击创建节点
2. 输入节点信息后点击创建,即创建成功
-
+ 
节点定义说明:
+
```
节点名称: 节点定义名称
归属: 节点所有者,可以选择个人或组织。组织在个人主页进行创建
@@ -26,36 +28,36 @@
描述: 节点定义的描述
```
-
-
### 2. 如何创建节点定义版本
-#### 2.1 通过Hub界面创建节点定义版本
+#### 2.1 通过 Hub 界面创建节点定义版本
+
1. 点击节点定义名称进入节点定义详情界面
2. 选择所有版本,点击创建版本
-3. 输入节点定义版本的dsl,点击确定,即创建成功
-
-
-节点定义版本dsl说明:
-
-| 关键字 | 说明 |
-| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ref | 归属人或归属组织的唯一标识/节点定义在归属内的唯一标识,必填,如:jianmu/hub_publish。若为官方节点定义,则可省略归属人或归属组织的唯一标识,如:hub_publish |
-| version | 节点定义的版本,必填 |
-| resultFile | 输出参数的文件路径,若定义了输出参数outputParameters,则必填 |
-| inputParameters | 输入参数列表 |
-| inputParameters.ref | 参数唯一标识,会在容器内转译成'JIANMU_'开头并大写的环境变量。如:hub_url在容器内可通过JIANMU_HUB_URL环境变量调用,必填 |
-|inputParameters.name| 参数名称,必填 |
-| inputParameters.type | 参数类型,支持STRING、SECRET、NUMBER、BOOLEAN等类型,必填。STRING/NUMBER/BOOLEAN: 若参数类型为STRING/NUMBER/BOOLEAN,可直接填写值或引用其他变量(事件、全局、其他任务的输出等参数)。SECRET: 若参数类型为SECRET,需要调用平台密钥,具体用法详见密钥管理章节 |
-| inputParameters.value | 参数默认值,若执行该节点定义时,没有指定参数值,将会使用此默认值,必填 |
-| inputParameters.description | 参数描述,选填 |
-| outputParameters | 输出参数,需要在"resultFile"指定的文件内填写对应的json数据,key为输出参数的ref值,格式同输入参数 |
-| spec | 镜像相关信息,节点定义类型为docker时,必填 |
-| spec.image | 指定该节点定义使用的容器镜像,执行时,平台将会从dockerhub拉取指定镜像,必填 |
-| spec.cmd | list格式,指定容器运行时的command内容,选填 |
-| spec.entrypoint | list格式,指定容器运行时的entrypoint内容,选填 |
+3. 输入节点定义版本的 dsl,点击确定,即创建成功
+ 
+
+节点定义版本 dsl 说明:
+
+| 关键字 | 说明 |
+| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ref | 归属人或归属组织的唯一标识/节点定义在归属内的唯一标识,必填,如:jianmu/hub_publish。若为官方节点定义,则可省略归属人或归属组织的唯一标识,如:hub_publish |
+| version | 节点定义的版本,必填 |
+| resultFile | 输出参数转换成 json 的文件路径,若定义了输出参数 outputParameters,则必填 |
+| inputParameters | 输入参数列表 |
+| inputParameters.ref | 参数唯一标识,会在容器内转译成'JIANMU\_'开头并大写的环境变量。如:hub_url 在容器内可通过 JIANMU_HUB_URL 环境变量调用,必填 |
+| inputParameters.name | 参数名称,必填 |
+| inputParameters.type | 参数类型,支持 STRING、SECRET、NUMBER、BOOLEAN 等类型,必填。STRING/NUMBER/BOOLEAN: 若参数类型为 STRING/NUMBER/BOOLEAN,可直接填写值或引用其他变量(事件、全局、其他任务的输出等参数)。SECRET: 若参数类型为 SECRET,需要调用平台密钥,具体用法详见密钥管理章节 |
+| inputParameters.value | 参数默认值,若执行该节点定义时,没有指定参数值,将会使用此默认值,必填 |
+| inputParameters.description | 参数描述,选填 |
+| outputParameters | 输出参数,需要在"resultFile"指定的文件内填写对应的 json 数据,key 为输出参数的唯一标识(ref)值,格式同输入参数 |
+| spec | 镜像相关信息,节点定义类型为 docker 时,必填 |
+| spec.image | 指定该节点定义使用的容器镜像,执行时,平台将会从 dockerhub 拉取指定镜像,必填 |
+| spec.cmd | list 格式,指定容器运行时的 command 内容,选填 |
+| spec.entrypoint | list 格式,指定容器运行时的 entrypoint 内容,选填 |
节点定义示例:
+
```
ref: git_clone
version: 1.0.1
@@ -112,13 +114,15 @@ spec:
```
相关链接:
+
1. 节点输出参数:[变量](vars.md)
2. 调用平台密钥:[密钥管理](secrets.md)
-3. spe的其他非必填参数:[spec参数](https://gitee.com/jianmu-dev/jianmu-ci-server/blob/master/embedded-worker/src/main/java/dev/jianmu/embedded/worker/aggregate/spec/ContainerSpec.java)
+3. spe 的其他非必填参数:[spec 参数](https://gitee.com/jianmu-dev/jianmu-ci-server/blob/master/embedded-worker/src/main/java/dev/jianmu/embedded/worker/aggregate/spec/ContainerSpec.java)
#### 2.2. 通过节点库中的`hub_publish`节点创建流程或管道推送该节点定义版本至节点库中
1.流程代码:
+
```
workflow:
name: 创建节点定义版本“hub-publish”
@@ -156,15 +160,12 @@ workflow:
- hub_publish
```
-
-hub_api_key获取步骤:
+hub_api_key 获取步骤:
1. 登录节点库
2. 点击头像进入个人主页,再点击个人中心
-3. 点击ApiKey管理,添加ApiKey
-
-
-
+3. 点击 ApiKey 管理,添加 ApiKey
+ 
2.管道代码;
@@ -189,10 +190,9 @@ pipeline:
hub_api_key: ((xxx.xxx))
```
-
-
执行成功后,查看节点定义详情界面,可以看到节点定义版本已经推送成功。

### 3. 内置输入参数
-share_dir: 共享目录,容器中可通过JM_SHARE_DIR使用
+
+share_dir: 共享目录,容器中可通过 JM_SHARE_DIR 使用