agileSpecs Markdown help

Markdown is a minimal syntax for marking up your documents with formatting, using punctuation and special characters. agileSpecs uses a modified version of the Markdown syntax. For those new to Markdown, this guide will help you become familiar with the full list of shortcuts and a few of our own additions.

Tickets

To create a new ticket place the cursor at the beginning of a new line and enter Ctrl-Space. The system automatically generates a new ticket number.

Please note: Tickets must start at the beginning of a new line and with an unique number. Project Owner and Admins can change the next coming ticket number under Settings > Tickets > Numbers.

Text Styling

Markdown Result
**bold** bold
*italics* italicize
***bold italic*** bold italic
~~strikeout~~
`verbatim`

 

Chapters

Chapters are set using a hash before the title. The number of hashes before the title text will determine the depth of the chapter.

# Section Level 1

Section Level 1

## Section Level 2

Section Level 2

### Section Level 3

Section Level 3

#### Section Level 4

Section Level 4

 

Lists & Tables

Prefacing a new line of text with a hyphen for each line will create an unordered list. For example:

- Item 1
- Item 2
- Item 3

 

Bullet:

<empty line>
- list 1
- list 2
- list 3
<empty line>
  • list 1
  • list 2
  • list 3

 

Numbered:

<empty line>
1. list 1
2. list 2
3. list 3
<empty line>
  1. list 1
  2. list 2
  3. list 3

 

Table:

<empty line>
Left|Center|Right
-|:-:|-:
First|yes|5,79
Second|no|780,50
<empty line>
Left Center Right
First yes 5,79
Second yes 780,50

 

Links

Create a link by putting the link text in brackets and the URL in parentheses,

like [this](https://agilespecs.com).

 

Images & References

Insert images and references to chapters by entering Ctrl-i.

 

Footnotes

Footnotes can be added to the body of your text using placeholders.

Normal text.^[Footnote]
Normal text.1
1Footnote

 

Source Code

```
// source code
int x = 0;
```
// source code
int x = 0;


This is all the Markdown syntax that's available in agileSpecs, but if you'd like to learn more about Markdown in general, you can see the complete syntax at Daring Fireball.

 

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk