When writing the description of a deployment step in Gearset Pipelines, you can format the content using Markdown.
Markdown is a commonly-used syntax for formatting text, allowing you to add headers, lists, sections, or embed more "rich" content like links and blocks of code.
You can also preview the description, which is useful where you've added some markdown and wish to see how it will be formatted once the step has been created.
If you're unfamiliar with it, here's a "cheat sheet" with some commonly used syntax, as well as some useful keyboard shortcuts.
Headers
Headers are inserted by adding a number of # characters before the header text. You can add between 1 and 6.
i.e.
# Header 1will format the text as anh1
To create an h1, h2, or h3, you can also use the keyboard shortcut ctrl/cmd + [1, 2, 3], where the number is the desired size.
Text formatting
Bold and Italics
Text can be made bold by adding ** before and after the text, or italicised by adding a _ before and after it.
i.e.
**bold**,_italics_
Adding bold text can be done with the keyboard shortcut ctrl/cmd + b, and italics with ctrl/cmd + i
Strike-through
You can also add a strike through text, by adding ~~ before and after it
i.e.
~~strike through~~
Adding strike through text can be done with the keyboard shortcut ctrl/cmd + shift + s
Code
To format a line of code, wrap it with backticks
i.e.
`code`
Adding code inline can be done with the keyboard shortcut ctrl/cmd + e
If you need to add a multi-line block of code, wrap the block with three backticks (```), you can also specify the language of the code next to the opening backticks and it will have syntax highlighting.
i.e.
```json
{
"firstName": "Joe",
"lastName": "Bloggs"
}
```
Links
Links can be embedded in your description using the following syntax [Link text](url), replacing the Link text and url appropriately
i.e.
[Gearset docs](https://docs.gearset.com/)
Adding a link can be done with the keyboard shortcut ctrl/cmd + shift + u
Alternatively, you can just paste a URL into your description without the syntax around it, and it will be embedded as a link.
Lists
Bulleted lists are created by adding a - in front of each list item, for sub-bullets, you add an indent to each bullet under the main point
i.e.
- Bulleted list item 1
- Bulleted list item 2
- It also supports adding sub-bullets
You can also add numbered lists by adding the order of the point before it
i.e.
1. Numbered list item 1
2. Numbered list item 2
Tables
Tables can be embedded using Markdown's table syntax - with | chars to separate columns and 3 or more hyphens (---) to create a header
i.e
| Header 1 | Header 2 |
| -------- | -------- |
| Value 1 | Value 2 |