Documentation (2024.2 Enterprise)

# Markdown

You can use Markdown to add text styles to:

- Issue tracking
- Commenting in code reviews
- Wiki

Helix TeamHub uses marked.js to support Markdown text formatting.

## Common Markdown styles

A number of the more common Markdown styles are shown below, for a more thorough list of the styles you can use, see the Markdown syntax.

### Headings

Headings are defined using hash # characters like this:

    # H1
    ## H2
    ### H3
    #### H4
    ##### H5
    ###### H6

For a Wiki, the Table of Contents for the page is automatically generated from headings H1 to H6. To make the Table of Contents render correctly, use the hash # character notation and nest the headings properly.

### Text Styles

- Italic formatting is specified with *Italic* or _Italic_
- Bold formatting is specified with **Bold** or __Bold__
- Bold and italic formatting can be mixed by specifying **Bold and _italic_**
- Strikethrough text formatting is specified with ~~Strikethough~~

### Lists

#### Ordered lists

    1. First
    2. second
      - Unordered sub list
      - and another line
    1. Actual numbers don't matter, just that it's a number

       You can have properly indented paragraphs within list items. **Note:** the blank line above this line and the leading spaces on this line (at least one leading space, but we have used three here to align the raw Markdown).
    1. and another number

Displays as:

1. First
2. Second
   - Unordered sub list
   - and another line
3. Actual numbers don't matter, just that it's a number

You can have properly indented paragraphs within list items. Note: the blank line above this line and the leading spaces on this line (at least one leading space, but we have used three here to align the raw Markdown).

4. and another number

#### Unordered lists

Unordered lists can be specified with asterisk * characters. Plus + and minus - characters also work:

    * This
    + That
    - Something else

Displays as:

- This
- That
- Something else

### Links

Links can be added in a number of ways depending on what you are linking to:

[Link to a URL](https://helixteamhub.com)

[Link to another wiki page](wiki-page:Page name)

[Link to an attachment](wiki-attachment:attachment-file-name.pdf)

For a Wiki, to link to attachments or other pages in the Wiki, click the Attach link in the Wiki Editor and choose one of the Files or Pages from the list.

### Images

Images can be added in a number of ways depending on where the image is located:

![Image from URL](https://example.com/picture.png)

![Image from attachments](wiki-attachment:picture-file-name.png)

### Code and Syntax Highlighting

#### Inline code

Mark text as inline code by adding a backtick ' character at both ends of the code like this `my inline code`.

#### Code blocks

You can mark blocks of code using three backtick ''' characters above and below the code block text, like this:

    ```javascript
    var s = "JavaScript syntax highlighting";
    alert(s);
    ```

- '''javascript in the example above specifies the language of the code block as JavaScript.
- Omit the language for automatic syntax highlighting.
- Disable syntax highlighting by setting the language to text.

### Tables

Tables are created by using pipe | character separators between columns and colon : characters for justification.

    | Tables   | Look   | Like this |
    | -------- | ----:  | :-------: |
    | Left     | right  | center    |

- The outer pipes |characters are optional and you don't need to make the raw Markdown line up.
- You can also use inline Markdown within the table cells.

### Blockquotes

You can blockquote text by using the greater than > character like this:

    > Blockquotes are very handy in email to emulate reply text.
    > This line is part of the same quote.

    Normal text resumes here.

### Horizontal Ruled lines

To create horizontal ruled line use multiple minus -, asterisk *, or underline _ characters like this:

    ---
    ***
    ___

### Line Breaks

Add a blank line between lines of text to start a new paragraph. If lines follow each other directly, they are rendered in the same paragraph. For example:

    Here's a line for us to start with.

    This line is separated from the one above by one blank line, so it will be a **separate paragraph**.

    This line is also a separate paragraph, but...
    This line is directly below the previous line of text, so it is a separate line in the **same paragraph**.

Displays like this:

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but... This line is directly below the previous line of text, so it is a separate line in the same paragraph.

Your search for returned results

Your search for returned results