# 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**](https://learn.mechanic.dev/core/tasks/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. ![](https://3145272362-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MQrnkixbmVHvKHMwAbm%2Fuploads%2Fgit-blob-ca9c419e21b97f6c25ce055d607596da9d1cd8e3%2FScreen%20Shot%202022-04-01%20at%207.20.38%20PM.png?alt=media) In Basic mode, documentation is displayed below the task options. ![](https://3145272362-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MQrnkixbmVHvKHMwAbm%2Fuploads%2Fgit-blob-60ad916853c63e6b89fa4dd66ec5edf15512e336%2FScreen%20Shot%202022-04-01%20at%207.21.15%20PM.png?alt=media) ## Markdown Task documentation may be formatted with Markdown, a common syntax for text formatting. The following table comes from [markdownguide.org/cheat-sheet](https://www.markdownguide.org/cheat-sheet/), and is presented with no changes, under the [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license. | **Element** | **Markdown Syntax** | | ------------------------------------------------------------------------------- | -------------------------------------------- | | [Heading](https://www.markdownguide.org/basic-syntax/#headings) | `# H1 ## H2 ### H3` | | [Bold](https://www.markdownguide.org/basic-syntax/#bold) | `**bold text**` | | [Italic](https://www.markdownguide.org/basic-syntax/#italic) | `_italicized text_` | | [Blockquote](https://www.markdownguide.org/basic-syntax/#blockquotes-1) | `> blockquote` | | [Unordered List](https://www.markdownguide.org/basic-syntax/#unordered-lists) | `- First item - Second item - Third item` | | [Ordered List](https://www.markdownguide.org/basic-syntax/#ordered-lists) | `1. First item 2. Second item 3. Third item` | | [Code](https://www.markdownguide.org/basic-syntax/#code) | `code` | | [Horizontal Rule](https://www.markdownguide.org/basic-syntax/#horizontal-rules) | `---` | | [Link](https://www.markdownguide.org/basic-syntax/#links) | `[title](https://www.example.com)` | | [Image](https://www.markdownguide.org/basic-syntax/#images-1) | `![alt text](image.jpg)` | ## 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.

🎬 Watch: Keyboard Shortcuts Demo

Action	Shortcut	Description
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	: `⌘`+`Shift`+`K` : `Ctrl`+`Shift`+`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. `![](url)`

### **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) ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://learn.mechanic.dev/core/tasks/advanced-settings/documentation.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.