Individual tasks may be optionally configured with their own documentation, formatted with Markdown, providing the user with anything they should know about the task's usage and operation.

Task documentation is shown to the user below the task's options. Documentation is also shown in the confirmation prompt a user sees when they trigger a task that subscribes to either mechanic/user/trigger or mechanic/user/text.

Adding documentation

Task documentation may be managed in Advanced mode.

In Basic mode, documentation is displayed below the task options.


Task documentation may be formatted with Markdown, a common syntax for text formatting.

The following table comes from, and is presented with no changes, under the CC BY-SA 4.0 license.


Markdown Syntax

# H1 ## H2 ### H3

**bold text**

*italicized text*

> blockquote

1. First item 2. Second item 3. Third item

- First item - Second item - Third item




![alt text](image.jpg)

Last updated