> For the complete documentation index, see [llms.txt](https://fulstech.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fulstech.gitbook.io/docs/markdown/markin-markdown-editor-for-jira/jira-cloud/markdown-syntax.md).

# Markdown Syntax

## Overview

![Markdown for Jira](/files/-Ma8B10HXqr1ay8bB3me)

## 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.

<figure><img src="/files/AHfBNWlfYGyglt1IyVUj" alt=""><figcaption><p>Markdown for Jira</p></figcaption></figure>

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.

<figure><img src="/files/okEsf4E6DDnmViMTWYkY" alt=""><figcaption><p>Markdown for Jira</p></figcaption></figure>

## LaTeX Math formulas

### Block formulas

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

![Render](/files/-Mf7VKN4Z4OSw1QEtUuK)

### Inline formulas

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

![Render](/files/-Mf7VQcp4jawAlyeqmlK)

## Sequence diagrams

Learn more about the syntax here: <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](/files/-Mf7SoOdiDAPGOvqBmZG)

## Graphviz diagrams

Learn more about the syntax (Graphviz DOT) here: <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](/files/-Mf7SVEtdfEEnODHuLba)

## Mermaid UML diagrams

Learn more about Mermaid UML diagrams here: <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](/files/-Mf7TWSY74w0jinQF_tH)

### 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](/files/-Mf7Tcbae4QJzYGm7C1s)

### 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](/files/-Mf7TqC54hIhF7MCKKm-)

## Markdown syntax

### Heading

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

![Result](/files/-Mf2kpT6s1VweTu6rzC9)

### Styling text

```markdown
**bold**

*italic*

~~Strikethrough~~
```

![Render](/files/-Mf2lMBRLjGiHJ1fnnBm)

### Lists

```markdown
* Item 1
* Item 2

1. Item 1
2. Item 2
```

![Render](/files/-Mf2lff-KY3v7RGQs-V5)

### Task lists

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

![](/files/-Mf2m6D0HC1hxW5l3ocI)

### Using emoji

```markdown
:) :D
```

![Render](/files/-Mf2mO993Gva3CiaHgJu)

### Mentioning people <a href="#mentioning-people" id="mentioning-people"></a>

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

![](https://fulstech.gitbook.io/~gitbook/image?url=https%3A%2F%2F3588362646-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-Ma7ua4NoSptEMaVrDMS%252F-MfvduIxK5YCP3iYywBh%252F-Mfvm1oeQmuIVVWZKbC9%252Fimage.png%3Falt%3Dmedia%26token%3D75528fd7-9d82-436b-821f-a1ce244a1dcf\&width=768\&dpr=4\&quality=100\&sign=950444b2\&sv=1)Input

![](https://fulstech.gitbook.io/~gitbook/image?url=https%3A%2F%2F3588362646-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-Ma7ua4NoSptEMaVrDMS%252F-MfvduIxK5YCP3iYywBh%252F-MfvmqAkeojUzAKAwPZS%252Fimage.png%3Falt%3Dmedia%26token%3D41368151-c6cf-4297-baa0-2c1e0b3710d3\&width=768\&dpr=4\&quality=100\&sign=44c9c1fe\&sv=1)Render

### Inserting attachments as images <a href="#inserting-attachments-as-images" id="inserting-attachments-as-images"></a>

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

![](https://fulstech.gitbook.io/~gitbook/image?url=https%3A%2F%2F3588362646-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-Ma7ua4NoSptEMaVrDMS%252F-MfvduIxK5YCP3iYywBh%252F-MfvoSqzWs5F1j7166b1%252Fimage.png%3Falt%3Dmedia%26token%3D8cc9b0b4-cde1-44f9-bda8-19529a259dc0\&width=768\&dpr=4\&quality=100\&sign=45ebfa70\&sv=1)

### Images

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

![Render](/files/-Mf2nEOcCnu-YkdMfpg4)

### Links

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

![Render](/files/-Mf2ok4GPY4HlRA71D1Y)

### Code snippets

````markdown
`inline code`

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

![Render](/files/-Mf2p286-cffg5AXRmPo)

### Quote blocks

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

![Render](/files/-Mf2pKDswmfduGi4Tj4Z)

### 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](/files/-Mf2pfbBE9tmVd8BTEz7)

## Gherkin syntax

> **Please enable Gherkin syntax first before using this feature.**

```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](/files/-Mf7Xn34A2zgO3-IFJiT)
