{"id":5625,"date":"2023-11-06T08:00:32","date_gmt":"2023-11-06T08:00:32","guid":{"rendered":"https:\/\/www.process.st\/help\/docs\/format-comments\/"},"modified":"2024-03-07T11:30:13","modified_gmt":"2024-03-07T11:30:13","slug":"format-comments","status":"publish","type":"ht_kb","link":"https:\/\/www.process.st\/help\/docs\/format-comments\/","title":{"rendered":"How to Format Your Comments with Markdown"},"content":{"rendered":"<p>You can format the <a href=\"https:\/\/www.process.st\/help\/docs\/comments\/\">comments<\/a> you make on tasks in workflow runs by using <a href=\"https:\/\/en.wikipedia.org\/wiki\/Markdown\">Markdown<\/a>.<\/p>\n<p>You might not know it by name, but if you\u2019ve formatted text in Slack, Trello or iA Writer before, then you\u2019ve used it.<\/p>\n<p>Markdown lets you\u00a0create rich text using a plain text editor. It allows you to bold, italicize, link, insert images, bullet lists, and add quotes to your text.<\/p>\n<p><iframe loading=\"lazy\" src=\"https:\/\/www.youtube.com\/embed\/mZSgDmE9HFI\" width=\"100%\" height=\"406\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"><span data-mce-type=\"bookmark\" style=\"display: inline-block; width: 0px; overflow: hidden; line-height: 0;\" class=\"mce_SELRES_start\">\ufeff<\/span><\/iframe><\/p>\n<h2>How to format comments<\/h2>\n<p>Use Markdown by typing in the comments of a task in one of your active workflow runs.<\/p>\n<p>The images below show the most common uses of Markdown, with the code you need to type on the left, and the final outcome on the right.<\/p>\n<p><img decoding=\"async\" class=\"alignnone\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/format-comments-markdown-1.png\" alt=\"format-comments-markdown-1\" width=\"100%\" \/><\/p>\n<p><img decoding=\"async\" class=\"alignnone\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/format-comments-markdown-2.png\" alt=\"format-comments-markdown-2\" width=\"100%\" \/><\/p>\n<p>To show markdown in action, below is an example of a comment you can type into a workflow run task, and above that is the output (after clicking &#8220;<strong>Comment<\/strong>&#8220;).<\/p>\n<p><img decoding=\"async\" class=\"alignnone size-full wp-image-13966\" src=\"https:\/\/www.process.st\/help\/wp-content\/uploads\/2024\/02\/comment-formatting.png\" alt=\"\" width=\"100%\" \/><\/p>\n<p>To learn more, check out this <a href=\"https:\/\/guides.github.com\/features\/mastering-markdown\/\">short guide on Markdown<\/a>, along with our other help articles on <a href=\"https:\/\/www.process.st\/help\/docs\/running-checklists\/\">running workflows<\/a>, the basics of creating and editing\u00a0<a href=\"https:\/\/www.process.st\/help\/docs\/templates\/\">workflows<\/a>, and <a href=\"https:\/\/www.process.st\/help\/docs\/comments\/\">comments<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>You can format the comments you make on tasks in workflow runs by using Markdown. You might not know it by name, but if you\u2019ve formatted text in Slack, Trello or iA Writer before, then you\u2019ve used it. Markdown lets you\u00a0create rich text using a plain text editor. It allows you to bold, italicize, link, [&hellip;]<\/p>\n","protected":false},"author":3,"template":"","meta":{"_acf_changed":false,"available_plan":"All plans","available_product":"Workflows","footnotes":""},"ht_kb_category":[168],"ht_kb_tag":[190,191,192],"class_list":["post-5625","ht_kb","type-ht_kb","status-publish","hentry","ht_kb_category-run-workflows","ht_kb_tag-commenting","ht_kb_tag-format","ht_kb_tag-markup"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/5625","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb"}],"about":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":1,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/5625\/revisions"}],"predecessor-version":[{"id":5626,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/5625\/revisions\/5626"}],"wp:attachment":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/media?parent=5625"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb_category?post=5625"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb_tag?post=5625"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}