diff --git a/docs/content/usage/with.md b/docs/content/usage/with.md index d15c9fd3..83407950 100644 --- a/docs/content/usage/with.md +++ b/docs/content/usage/with.md @@ -9,18 +9,18 @@ This page describes the elements that can be specified in with. | key | value | default | | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -| [status](/usage/with#status) | `'success'` or `'failure'` or `'cancelled'` or `'custom'` | `''` | +| [status](#status) | `'success'` or `'failure'` or `'cancelled'` or `'custom'` | `''` | | [fields](/usage/fields) | You can choose the items you want to add to the fields at the time of notification. | `'repo,commit'` | -| [text](/usage/with#text) | Specify the text you want to add. All strings will be overwritten. | `''` | -| [author_name](/usage/with#author_name) | It can be overwritten by specifying. The job name is recommend. | `'8398a7@action-slack'` | -| [mention](/usage/with#mention) | `'here'` or `'channel'` or [user_group_id](https://api.slack.com/reference/surfaces/formatting#mentioning-groups) or [user_id](https://api.slack.com/reference/surfaces/formatting#mentioning-users) | `''` | -| [if_mention](/usage/with#mention) | Specify `'success'` or `'failure'` or `'cancelled'` or `'custom'` or `'always'`. | `''` | -| [username](/usage/with#username) | Override the legacy integration's default name. | `''` | -| [icon_emoji](/usage/with#icon_emoji) | [emoji code](https://www.webfx.com/tools/emoji-cheat-sheet/) string to use in place of the default icon. | `''` | -| [icon_url](/usage/with#icon_url) | icon image URL string to use in place of the default icon. | `''` | -| [channel](/usage/with#channel) | Override the legacy integration's default channel. This should be an ID, such as `C8UJ12P4P`. | `''` | -| [custom_payload](/usage/with#custom_payload) | e.g. `{"text": "Custom Field Check", obj: 'LOWER CASE'.toLowerCase()}` | `''` | -| [job_name](/usage/with#job_name) | If you want to overwrite the job name, you must specify it. | `''` | +| [text](#text) | Specify the text you want to add. All strings will be overwritten. | `''` | +| [author_name](#author_name) | It can be overwritten by specifying. The job name is recommend. | `'8398a7@action-slack'` | +| [mention](#mention) | `'here'` or `'channel'` or [user_group_id](https://api.slack.com/reference/surfaces/formatting#mentioning-groups) or [user_id](https://api.slack.com/reference/surfaces/formatting#mentioning-users) | `''` | +| [if_mention](#mention) | Specify `'success'` or `'failure'` or `'cancelled'` or `'custom'` or `'always'`. | `''` | +| [username](#username) | Override the legacy integration's default name. | `''` | +| [icon_emoji](#icon_emoji) | [emoji code](https://www.webfx.com/tools/emoji-cheat-sheet/) string to use in place of the default icon. | `''` | +| [icon_url](#icon_url) | icon image URL string to use in place of the default icon. | `''` | +| [channel](#channel) | Override the legacy integration's default channel. This should be an ID, such as `C8UJ12P4P`. | `''` | +| [custom_payload](#custom_payload) | e.g. `{"text": "Custom Field Check", obj: 'LOWER CASE'.toLowerCase()}` | `''` | +| [job_name](#job_name) | If you want to overwrite the job name, you must specify it. | `''` | ### status