You can go beyond basic text and apply formatting for certain text fields in Uptick including:
- Scope of works
- Internal notes
- Access notes
- Snippets
- Timeline
This guide will show you how you can make the most of Markdown formatting to format your text in various ways (where supported).
Headings
To create a heading, add number signs (#
) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example, to create a heading level three , use three number signs (e.g., ### My Header
).
Markdown |
Output |
# Heading level 1 |
Heading level 1 |
## Heading level 2 |
|
### Heading level 3 |
Heading level 3 |
#### Heading level 4 |
Heading level 4 |
##### Heading level 5 |
Heading level 5 |
###### Heading level 6 |
Heading level 6 |
Emphasis
You can add emphasis by making text bold, italic or both.
Italic
To italicise text, add one asterisk or underscore before and after a word or phrase.
Markdown |
Output |
*Italicised text* |
Italicised text |
_Also italicised text_ |
Also italicised text |
Bold
To bold text, add two asterisks or underscores before and after a word or phrase.
Markdown |
Output |
**Bold text** |
Bold text |
__Also bold text__ |
Also bold text |
Bold and Italic
To emphasise text with bold and italics at the same time, add three asterisks or underscores before and after a word or phrase.
Markdown |
Output |
This text is ***really important***. |
This text is really important. |
This text is ___really important___. |
This text is really important. |
Lists
You can organise items into ordered lists (numbered lists) and unordered lists (bulleted lists).
Note regarding indentation: Do not use the Tab key for indentation as this will jump the cursor to the next field. Using four spaces will translate to an indent.
Numbered Lists
To create an ordered list, add line items with numbers followed by periods. Simply starting the line with any number followed by a period will be interpreted as the next number in the list (i.e: a 4-item list where each line starts with 1. will still number the items 1 to 4 accordingly).
Markdown |
Output |
|
|
|
|
|
|
|
|
Bulleted Lists
To create an unordered list, add dashes (-
), asterisks (*
), or plus signs (+
) in front of line items. Indent one or more items to create a nested list.
Markdown |
Output |
|
|
|
|
|
|
|
|
Horizontal Line
To create a horizontal rule, use three or more asterisks (***
), dashes (---
). Make sure there are blank lines before and after this otherwise it will interrupt the formatting of other parts of the text.
***
---
Which ever format you choose to use, the output will look like the line below.
Links and Email Addresses
- The https:// part of the link must be present in order for it to be interpreted as a link.
- To quickly turn a URL or email address into a link, enclose it in angle brackets.
- You can also use bold and italic formatting on links as well.
- To create a link, enclose the link text in square brackets and then follow it immediately with the URL in brackets like the example below.
Markdown |
Output |
|
Visit the website. |
<https://www.uptickhq.com> |
|
<support@uptickhq.com> |
|
*<support@uptickhq.com>* |
|
**<support@uptickhq.com>** |
|
***<support@uptickhq.com>*** |
Mouse-over tooltip
Allows a tooltip to appear when the user hovers over the link for a few seconds. The tooltip can be added by enclosing your message of choice in quotes after the URL before the closing bracket.
Markdown |
|
Output |
![]() |
Escaping Characters
If you want to actually use these symbols instead of the Markdown translating it (i.e you want to use * without it turning into a bullet point or emphasising text), place a\
in front of the character. See the example below:
\* Without the backslash, this would be a bullet in an unordered list.
The rendered output looks like this:
* Without the backslash, this would be a bullet in an unordered list.
Characters You Can Escape
You can use a backslash to escape the following characters.
Character | Name |
\ | backslash (in this case a \\ will display as a \ ) |
` | backtick |
* | asterisk |
_ | underscore |
{ } | curly braces |
[ ] | brackets |
< > | angle brackets |
( ) | parentheses |
# | pound sign |
+ | plus sign |
- | minus sign (hyphen) |
. | dot |
Comments
0 comments
Please sign in to leave a comment.