# Markdown Syntax

## Overview

![Markdown for Jira](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2Fsync%2Ff3ff436c438a3614421d483534076379fb994ae6.png?generation=1621504371591214\&alt=media)

## Autocompletion

You can get a list of all available syntax by pressing `Ctrl + Space` in the editor. A context menu with all available syntax will appear.

![Markdown for Jira](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-MfvduIxK5YCP3iYywBh%2F-MfvpatfBjW-Dar1TQqT%2Fimage.png?alt=media\&token=aaf3bdca-d42f-41e5-9b8b-b8efa1f5be0e)

To move between items, use `Up`, `Down`, `Left`, `Right` keys. To select an item, click on it or press `Enter`. An example will be inserted.

![Markdown for Jira](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-MfvduIxK5YCP3iYywBh%2F-MfvqEeWAyCAQ-wPLyYg%2Fimage.png?alt=media\&token=4f421a27-56ec-4c9c-ae5a-9aad065c00e9)

## LaTeX Math formulas

### Block formulas

```latex
\\[ax^2 + bx + c = 0\\]
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf7QOcgWTcx5HPOxjr0%2F-Mf7VKN4Z4OSw1QEtUuK%2Fimage.png?alt=media\&token=a784391f-9bbc-4352-b959-d58293bff302)

### Inline formulas

```latex
\\(x = {-b \pm \sqrt{b^2-4ac} \over 2a}\\)
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2Fsync%2F160769f00b0895c8cdafabd7ef761560632a521f.png?generation=1626948767000003\&alt=media)

## Sequence diagrams

Learn more about the syntax here: [https://bramp.github.io/js-sequence-diagrams](https://bramp.github.io/js-sequence-diagrams).

````markdown
:::sequence
```
User->Phone: Says Hello
Note right of Phone: Phone thinks\nabout it
Phone->User: How are you?
User->>Phone: I am good thanks!
```
:::
````

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf7QOcgWTcx5HPOxjr0%2F-Mf7SoOdiDAPGOvqBmZG%2Fimage.png?alt=media\&token=2f735551-10a2-4954-aa3a-3c7e3964c7c1)

## Graphviz diagrams

Learn more about the syntax (Graphviz DOT) here: [http://www.graphviz.org/](http://www.graphviz.org/).

````dot
:::graphviz
```
digraph site {
    home [label = "Home"];
    prod [label = "Products"];
    news [label = "News"];
    cont [label = "Contact"];

    home -> {prod news cont} 
}
```
:::
````

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf7QOcgWTcx5HPOxjr0%2F-Mf7SVEtdfEEnODHuLba%2Fimage.png?alt=media\&token=3fc98f82-2fe8-4835-8817-670ece9a2b1b)

## Mermaid UML diagrams

Learn more about Mermaid UML diagrams here: [https://mermaid-js.github.io/mermaid/#/](https://mermaid-js.github.io/mermaid/#/).

Here we are just showing some examples.

### State diagrams

````mermaid
:::uml
```
stateDiagram
        [*] --> Still
        Still --> [*]
        Still --> Moving
        Moving --> Still
        Moving --> Crash
        Crash --> [*]
```
:::
````

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf7QOcgWTcx5HPOxjr0%2F-Mf7TWSY74w0jinQF_tH%2Fimage.png?alt=media\&token=c368a46b-a5ca-45c7-923f-074ca9a2d25d)

### Sequence diagrams

````mermaid
:::uml
```
sequenceDiagram
    autonumber
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
```
:::
````

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf7QOcgWTcx5HPOxjr0%2F-Mf7Tcbae4QJzYGm7C1s%2Fimage.png?alt=media\&token=b3aa9e8b-8f06-4709-afff-79e468597c69)

### Class diagrams

````mermaid
:::uml
```
classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label
```
:::
````

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf7QOcgWTcx5HPOxjr0%2F-Mf7TqC54hIhF7MCKKm-%2Fimage.png?alt=media\&token=0ed695ca-fbaf-491e-8a83-35f69a8a354c)

## Markdown syntax

### Heading

```
# The largest heading
## The second largest heading
###### The smallest heading
```

![](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-MfCh-g_qw_ZmKxfEPbe%2F-MfChguiH0ygjtjCeSr4%2Fimage.png?alt=media\&token=46410683-1533-4a4e-8abc-c1ca692f88b5)

### Styling text

```markdown
**bold**

*italic*

~~Strikethrough~~
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2lMBRLjGiHJ1fnnBm%2Fimage.png?alt=media\&token=e9ccc01f-1e5a-4a28-a7ab-8cafaeb0db23)

### Lists

```markdown
* Item 1
* Item 2

1. Item 1
2. Item 2
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2lff-KY3v7RGQs-V5%2Fimage.png?alt=media\&token=10f60c7d-32bd-4b68-a5d5-85ed8327390f)

### Task lists

```markdown
- [x] this is a complete item
- [ ] this is an incomplete item
```

![](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2m6D0HC1hxW5l3ocI%2Fimage.png?alt=media\&token=9e23c69a-8944-426f-9df0-4bb559644b8c)

### Using emoji

```markdown
:) :D
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2mO993Gva3CiaHgJu%2Fimage.png?alt=media\&token=e492264a-2e1b-4ae1-9d1c-30676b27e920)

### Mentioning people

Type `@` and select the user to be mentioned.

![Input](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-MfvduIxK5YCP3iYywBh%2F-Mfvm1oeQmuIVVWZKbC9%2Fimage.png?alt=media\&token=75528fd7-9d82-436b-821f-a1ce244a1dcf)

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-MfvduIxK5YCP3iYywBh%2F-MfvmqAkeojUzAKAwPZS%2Fimage.png?alt=media\&token=41368151-c6cf-4297-baa0-2c1e0b3710d3)

### Inserting attachments as images

Type `@@` and select the attachment to be inserted.

![Input](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-MfvduIxK5YCP3iYywBh%2F-MfvoSqzWs5F1j7166b1%2Fimage.png?alt=media\&token=8cc9b0b4-cde1-44f9-bda8-19529a259dc0)

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-MfvduIxK5YCP3iYywBh%2F-Mfvob5czEeXgxpWQ6tb%2Fimage.png?alt=media\&token=179f9304-1bab-4720-8373-cd0558150161)

### Images

```markdown
![Markdown Logo (Source: Wikipedia)](https://upload.wikimedia.org/wikipedia/commons/4/48/Markdown-mark.svg)
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2nEOcCnu-YkdMfpg4%2Fimage.png?alt=media\&token=14171306-fcac-47cd-87d4-233e8c663738)

### Links

```markdown
[Markin](https://marketplace.atlassian.com/plugins/com.fulstech.jira-gherkin-custom-field/server/overview)
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2ok4GPY4HlRA71D1Y%2Fimage.png?alt=media\&token=70915e18-5ad2-43fe-a42d-9770cb3f6144)

### Code snippets

````markdown
`inline code`

```javascript
function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:"#foo"})
  }
}
```
````

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2p286-cffg5AXRmPo%2Fimage.png?alt=media\&token=944f2803-9ea4-48f7-bffa-ef90f209f249)

### Quote blocks

```
As Eleanor Roosevelt said:
> You must do the thing you think you cannot do.
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2pKDswmfduGi4Tj4Z%2Fimage.png?alt=media\&token=ae7eb5a1-92ba-46dd-b0a8-f06003c36a32)

### Tables

```markdown
| First Header | Second Header |
| - | - |
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf2j5d3WUIkh0kyMGKv%2F-Mf2pfbBE9tmVd8BTEz7%2Fimage.png?alt=media\&token=cbf86045-3912-41ea-b711-701a4958996a)

## Gherkin syntax

> **Please enable the line-break option and the Gherkin syntax first before using this feature.**

<figure><img src="https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ma7ua4NoSptEMaVrDMS%2Fuploads%2FXr6znsi0oVmhxRucMdUU%2Fimage.png?alt=media&#x26;token=46a7934b-113c-46f0-b2e9-a1f427a7a8be" alt="" width="222"><figcaption><p>Configuration</p></figcaption></figure>

<figure><img src="https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ma7ua4NoSptEMaVrDMS%2Fuploads%2FB5tf6jgxR02YnWvxGUad%2Fimage.png?alt=media&#x26;token=d717a9dd-43d9-4d2d-be11-cf7f8ea5f794" alt="" width="305"><figcaption><p>Configuration</p></figcaption></figure>

```gherkin
Scenario Outline: Password should be secure enough

Given a new password is being set
When I try to set the password to <new password>
Then the password should be considered <secure?>

Examples:
| new password | secure? | notes                  |
| -            | -       | -                      |
| p@swrd1;     | :(      | No uppercase character |
| Passwrd1     | :(      | No special character   |
| P@swrdl;     | :)      | -                      |
```

![Render](https://3588362646-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Ma7ua4NoSptEMaVrDMS%2F-Mf7WDwAQmC_HOAWP5bu%2F-Mf7Xn34A2zgO3-IFJiT%2Fimage.png?alt=media\&token=88c4aad3-47f3-4be7-a7f1-d774779418cc)
