Formatting Text: Markdown, Liquid

22min
adding dynamic content with liquid kickplan uses the liquid templating language to add data to your customer related templates (email, invoices, etc ) liquid is a flexible, safe language used in many different environments and was originally created for use in shopify stores liquid basics objects contain the content that liquid displays on a page objects and variables are displayed when enclosed in double curly braces {{ and }} input {{ page title }} output introduction in this case, liquid is rendering the content of the title property of the page object, which contains the text introduction tags create the logic and control flow for templates the curly brace percentage delimiters {% and %} and the text that they surround do not produce any visible output when the template is rendered this lets you assign variables and create conditions or loops without showing any of the liquid logic on the page input {% if user %} hello {{ user name }}! {% endif %} output hello adam! learn more about liquid for full documentation on the features and syntax of liquid, please review the docs at https //shopify github io/liquid/ https //shopify github io/liquid/basics/introduction/ markdown writing and formatting syntax kickplan markdown matches github flavored markdown very closely headings to create a heading, add one to six # symbols before your heading text the number of # you use will determine the hierarchy level and typeface size of the heading \# a first level heading ## a second level heading ### a third level heading text styles you can indicate emphasis with bold, italic, strikethrough, subscript, or superscript text style syntax keyboard shortcut example output bold or command+b (mac) or ctrl+b (windows/linux) this is bold text this is bold text italic or command+i (mac) or ctrl+i (windows/linux) this text is italicized this text is italicized strikethrough none this was mistaken text this was mistaken text bold and nested italic and none this text is extremely important this text is extremely important all bold and italic none all this text is important all this text is important subscript \<sub> \</sub> none this is a \<sub>subscript\</sub> text this is a subscript text superscript \<sup> \</sup> none this is a \<sup>superscript\</sup> text this is a superscript text quoting text you can quote text with a > text that is not a quote \> text that is a quote quoted text is indented, with a different type color tables each table row consists of cells containing arbitrary text separated by pipes (|) a leading and trailing pipe is also recommended for clarity of reading spaces between pipes and cell content are trimmed block level elements cannot be inserted in a table the delimiter row consists of cells whose only content are hyphens ( ), and optionally, a leading or trailing colon ( ), or both, to indicate left, right, or center alignment respectively \| foo | bar | \| | | \| baz | bim | cells in one column don’t need to match length, though it’s easier to read if they are likewise, use of leading and trailing pipes may be inconsistent \| abc | defghi | \ | bar | baz \<table> \<thead> \<tr> \<th align="center">abc\</th> \<th align="right">defghi\</th> \</tr> \</thead> \<tbody> \<tr> \<td align="center">bar\</td> \<td align="right">baz\</td> \</tr> \</tbody> \</table> include a pipe in a cell’s content by escaping it, including inside other inline spans \| f\\|oo | \| | \| b `\\|` az | \| b \\| im | the header row must match the delimiter row in the number of cells if not, a table will not be recognized quoting code you can call out code or a command within a sentence with single backticks the text within the backticks will not be formatted you can also press the command+e (mac) or ctrl+e (windows/linux) keyboard shortcut to insert the backticks for a code block within a line of markdown a line of code to format code or text into its own distinct block, use triple backticks ``` function addnumbers(a, b) { return a + b; } ``` supported color models in issues, pull requests, and discussions, you can call out colors within a sentence by using backticks a supported color model within backticks will display a visualization of the color the background color is `#ffffff` for light mode and `#000000` for dark mode here are the currently supported color models color syntax example output hex `#rrggbb` `#0969da` rgb `rgb(r,g,b)` `rgb(9, 105, 218)` hsl `hsl(h,s,l)` `hsl(212, 92%, 45%)` note a supported color model cannot have any leading or trailing spaces within the backticks the visualization of the color is only supported in issues, pull requests, and discussions links you can create an inline link by wrapping link text in brackets \[ ], and then wrapping the url in parentheses ( ) you can also use the keyboard shortcut command+k to create a link when you have text selected, you can paste a url from your clipboard to automatically create a link from the selection you can also create a markdown hyperlink by highlighting the text and using the keyboard shortcut command+v if you'd like to replace the text with the link, use the keyboard shortcut command+shift+v \[link text]\(https //www example com) images you can display an image by adding ! and wrapping the alt text in \[ ] alt text is a short text equivalent of the information in the image then, wrap the link for the image in parentheses () !\[screenshot of a comment on a github issue showing an image, added in the markdown, of an octocat smiling and raising a tentacle ]\(https //myoctocat com/assets/images/base octocat svg) !\[alt text]\(https //www example com/image jpg lists you can make an unordered list by preceding one or more lines of text with , , or + \ george washington john adams \+ thomas jefferso to order your list, precede each line with a number 1\ james madison 2\ james monroe 3\ john quincy adams nested lists you can create a nested list by indenting one or more list items below another item to create a nested list, you can align your list visually type space characters in front of your nested list item until the list marker character ( or ) lies directly below the first character of the text in the item above it 1\ first list item \ first nested list item \ second nested list item task lists to create a task list, preface list items with a hyphen and space followed by \[ ] to mark a task as complete, use \[x] \ \[x] #739 \ \[ ] https //github com/octo org/octo repo/issues/740 \ \[ ] add delight to the experience when all tasks are complete 🎉 if a task list item description begins with a parenthesis, you'll need to escape it with \\ \ \[ ] \\(optional) open a followup issue