Supported Markdown

The following markdown formatting is supported in the ticket Description and ticket Comments fields:

Headings - # heading1, ## heading 2 ...

Line breaks - end a line with TWO spaces before hitting return

Bold - ** this text will be bold **. or __this text is bold__

Italic - *this text is italic* or _this text is italic_

Bold and italic - *** bold and italic *** or ___bold and italic___

Strikethrough - ~~this text will be stricken~~

Block quote

> This text will be blockquoted

Unordered Lists

prefix each item with *, - or +

Ordered lists

prefix each item with a number and period - start with 1., but then any number is acceptable.

Code Blocks

indent with four spaces or one tab

You can create fenced code blocks by prefixing and ending the block of code with three backticks or three tildes

for example

```
this will be rendered
as code
```
~~~
so will 
this 
~~~

Divider line

***, or ___

Definition Lists

prefix each definition item with : for example,

first term : definition of first term second term : definition of second term : alternate definition of second term

Tables

Use the bar char to delineate each cell, and three or more hyphens to create an underline, for example:

| heading 1 | heading 2 | | --- | --- | | data 1 | data 2| | data 3 | data 4| |: left aligned | right aligned:| |: centered: | |

Footnotes

To create a footnote, use the format [^1] and [^2] etc for the placeholders in your text

where you want the footnote reference to be.

[^2]: footnote 2 text you can then put the text of the footnotes anywhere in your content [^1]: footnote 1 txt and it will be moved to the bottom of the document when it is rendered. if you want to add a long footnote [^3] you can create it thus: [^3]: for long footnotes indent the lines with four spaces then all the indented content will be considered part of the footnote again, the position of the footnote content in the document does not matter it will be moved to the end on render.

For more information on the many features of markdown, see https://www.markdownguide.org/basic-syntax/ but note EIP does not support HTML within ticket comments and description for security reasons.