Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents, it’s purpose is to give your document a better style without using HTML or CSS languages.
You can use markdown if you want to bold certain text in your step description, or if you would like to insert line breaks. We have included some standard use cases for you to copy and paste into your step description as below.
To implement markdown in your workflow you can do this when creating your workflow in the Editor.
To bold text, add two asterisks before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.
To add a line break you will need to wrap <p> around your text like below:
<p>I really like using Markdown.<p>
I really like using Markdown.
To italicise text, add one asterisk before and after a word or phrase. To italicise the middle of a word for emphasis, add one asterisk without spaces around the letters.
Italicised text is the *cat's meow*.
Italicised text is the cat’s meow.
Using bullet points
To create an unordered list, add dashes (-) in front of line items. Indent one or more items to create a nested list.
- First item
- Second item
- Third item
- Fourth item
You can find a wealth of examples of markdown formatting in the following design document https://www.markdownguide.org/basic-syntax/ once you have identified the formatting you want to achieve simply copy and paste the markdown example and replace the text in your step description in your editor.