Documentation

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.

Markdown

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

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

Element	Markdown Syntax
Heading	# H1 ## H2 ### H3
Bold	**bold text**
Italic	_italicized text_
Blockquote	> blockquote
Unordered List	- First item - Second item - Third item
Ordered List	1. First item 2. Second item 3. Third item
Code	code
Horizontal Rule	---
Link	[title](https://www.example.com)
Image	

Keyboard Shortcuts

The Markdown editor in Mechanic includes keyboard shortcuts for common formatting operations. These shortcuts can also be accessed through the right click menu in the editor.

Action	Shortcut	Description
Toggle Bold	: ⌘+B : Ctrl+B	Adds or removes Bold formatting on selected text or current word. **text**
Toggle Italic	: ⌘+I : Ctrl+I	Adds or removes Italic formatting on selected text or current word. _text_
Toggle Strikethrough	: ⌘+Shift+X : Ctrl+Shift+X	Adds or removes Strikethrough on selected text or current word. ~text~
Toggle Heading	: ⌘+Shift+H : Ctrl+Shift+H	Cycles through Heading formats. → H1 → H2 → H3 → Plain Text → # text → ## text → ### text → text
Toggle Inline Code	: ⌘+Shift+E : Ctrl+Shift+E	Adds or removes Inline Code formatting on selected text or current word. `code`
Toggle Code Block	: ⌘+Shift+E : Ctrl+Shift+E	Adds or removes a Code Block on multiline selection or blank line. ``` code ```
Toggle List	: ⌘+Shift+L : Ctrl+Shift+L	Cycles through List formats. → Unordered List → Ordered List → Plain Text → - text → 1. text → text
Toggle Link	: ⌘+K : Ctrl+K	Adds or removes Link formatting. [text](url)
Toggle Blockquote	: ⌘+Shift+B : Ctrl+Shift+B	Adds or removes Blockquote formatting. > text
Toggle Image	: ⌘+Shift+I : Ctrl+Shift+I	Adds or removes Image formatting. 

Pasting URLs

When pasting a valid URL, if you have text selected the selected text will automatically be wrapped in Markdown link syntax using the pasted URL. The selected text becomes the link text, and the pasted URL becomes the link destination.

→ [selected text](https://pastedurl.com)