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

![Markdown for Jira](/files/-MfvpatfBjW-Dar1TQqT)

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](/files/-MfvqEeWAyCAQ-wPLyYg)

## 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/-MfCgxZbY7W-YRga3hJS)

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

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

![](/files/-MfChguiH0ygjtjCeSr4)

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

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

![Input](/files/-Mfvm1oeQmuIVVWZKbC9)

![Render](/files/-MfvmqAkeojUzAKAwPZS)

### Inserting attachments as images

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

![Input](/files/-MfvoSqzWs5F1j7166b1)

![Render](/files/-Mfvob5czEeXgxpWQ6tb)

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

```
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 the line-break option and the Gherkin syntax first before using this feature.**

<figure><img src="/files/vH5fbvI9QZxBqz6adkAP" alt="" width="222"><figcaption><p>Configuration</p></figcaption></figure>

<figure><img src="/files/XqFH4QttMQgEcIqOsn0r" 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](/files/-Mf7Xn34A2zgO3-IFJiT)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fulstech.gitbook.io/docs/markdown/markin-markdown-editor-for-jira/jira-data-center-and-jira-server/markdown-syntax.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.