GitScrum
Try free

Markdown Guide

GitScrum Studio supports Markdown formatting in task descriptions, comments, wiki pages, and documentation. This guide covers all supported syntax with examples.

Why Markdown

Markdown lets you write formatted content without leaving your keyboard. No buttons to click, no menus to navigate. Just type the syntax and see the result.

Developers already use Markdown in READMEs, documentation, and issue trackers. GitScrum uses the same syntax you know from GitHub.

Basic Formatting

Headings

Create headings with # symbols:

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Emphasis

*italic* or _italic_
**bold** or __bold__
***bold italic*** or ___bold italic___
~~strikethrough~~

Line Breaks

End a line with two spaces for a soft break. Or use an empty line for a paragraph break.

Lists

Unordered Lists

- Item one
- Item two
  - Nested item
  - Another nested
- Item three

Ordered Lists

1. First item
2. Second item
   1. Nested numbered
   2. Another nested
3. Third item

Task Lists

- [ ] Unchecked task
- [x] Completed task
- [ ] Another pending task

Links and Images

Links

[Link text](https://example.com)
[Link with title](https://example.com "Hover title")

Images

![Alt text](image-url.png)
![Alt text](image-url.png "Image title")

Reference Links

[Link text][reference]

[reference]: https://example.com

Code

Inline Code

Use backticks for inline code: const x = 42;

Code Blocks

Use triple backticks with optional language:

function hello(name) {
  return `Hello, ${name}!`;
}

Supported languages for syntax highlighting:

  • javascript, typescript, jsx, tsx
  • python, ruby, php
  • html, css, scss
  • json, yaml, markdown
  • bash, shell
  • sql
  • go, rust, java, c, cpp

Blockquotes

> This is a blockquote
> spanning multiple lines

> Nested quotes
>> Second level
>>> Third level

Tables

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Alignment:

| Left | Center | Right |
|:-----|:------:|------:|
| L    |   C    |     R |

Horizontal Rules

Use three or more hyphens, asterisks, or underscores:

---
***
___

Special Features

Mentions

Mention team members with @:

@johndoe please review this

Task References

Link to tasks with #:

Related to #123
Blocks #456

Labels

Reference labels with ~:

Add ~bug label
Tagged as ~priority:high

Escaping Characters

Use backslash to show literal characters:

\*not italic\*
\# not a heading
\[not a link\]

Keyboard Keys

Display keyboard shortcuts:

Press <kbd>Cmd</kbd> + <kbd>K</kbd> to search

Best Practices

Task Descriptions

  • Start with a clear summary sentence
  • Use headers to organize sections
  • Include code blocks for technical details
  • Add task lists for acceptance criteria

Wiki Pages

  • Use descriptive headings for navigation
  • Include a table of contents for long pages
  • Link to related pages
  • Update the modification date

Comments

  • Keep it concise
  • Quote relevant context
  • Use code blocks for logs/errors
  • Mention people who need to see it

Common Mistakes

No space after #

❌ #Heading
✅ # Heading

Broken nested lists

❌ 
- Item
 - Nested (only 1 space)

✅ 
- Item
  - Nested (2 spaces)

Unclosed code blocks Always use matching triple backticks.

Preview Mode

Most text fields in GitScrum show a preview as you type. Toggle between edit and preview modes to see the final result before saving.

How to Report a Problem or Request a Feature

If markdown isn't rendering correctly or you need additional syntax support, submit feedback through GitScrum Studio. In the Sidebar, click on Support Tickets and open a ticket.

← Previous Next →