Using Markdown: Linking documents/websites, adding images, and stylising text

Award Force uses markdown for content formatting across the system. It's a very simple and quick to learn method of formatting, inspired by plain text email. 

Using Markdown formatting, websites, documents, images and videos can be inserted into almost any location. Common examples include content blocks and hint text on fields.

In the words of its creator (John Gruber), "The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions."

In each of the below sections, you'll find the markdown split over two lines:

The first line, in this format, shows the markdown being used.

 The second line shows the visual effect of the markdown.

Emphasis

Bold

This is how you **bold** text

This is how you bold text

Italics

This is how you *italicise* text

This is how you italicise text.

Lists
Note: Lists are not supported in labels. You will need to use the hint box instead.

Bulleted lists

* Bullet one
* Bullet two
  • Bullet one
  • Bullet two
Note: There must be a line break before and after the list.

Numbered lists

1. Step one
2. Step two
  1. Step one
  2. Step two
Note: Do not use a hashtag (#) when creating numbered lists in Markdown as the symbol is used for other formatting.
Headings
# Heading 1
## Heading 2
### Heading 3

Heading 1

Heading 2

Heading 3

Note: If you prefer, you can add a row of equal signs (=) under a line of text to create Heading one effect, or a row of dashes (-) under a line of text to create a Heading two effect.
Link to a website/email address/phone number
[Link display text - URL](http://example.com/)

Link display text - URL

[Link display text - Email](mailto:example@mail.com)

Link display text - Email

[Link display text - Phone](tel:+61283106640)

Link display text - Phone

While the above examples all use similar formatting, you can see the variations when the link is clicked. The email option will open in the system-set email composer, and phone in the system-set phone dialler. 

Note: The 'phone' link type is intended for use when mobile browsing, and may not work in desktop view unless the user has a phone application (e.g. Skype) installed. The full international version of the number is required.
Link to a document or image

Documents and images need to be hosted outside of Award Force before they can be linked to.

For example, you may have a marketing website or intranet where these files can be stored. Alternatively, you can use a service like Dropbox to host the files.

Ensure the URL to your document ends with the format of the file eg. .pdf or .jpg. URLs ending in .html or .php won't work.

[Link display text - Document](http://www.example.com)

Link display text - Document

This link will look the same as the URL options above, however will open the document in a new tab.

Video embedding

Videos need to be hosted outside of Award Force before they can be linked or embedded. For example, you may have a marketing website where these files can be stored. Alternatively, you can use a service like Dropbox to host the files.

![300](https://vimeo.com/292291821/0c7d51acd2)

  • The number in square brackets defines the width to display the video at (in pixels)
  • The video is embedded at 16:9 (wide-screen) aspect ratio. If the source video is a different aspect ratio, it will be letter-boxed / pillar-boxed in the player.
  • Embedding is supported for Vimeo and YouTube URLs.
Image embedding

Images need to be hosted outside of Award Force before they can be linked or embedded. For example, you may have a marketing website where these files can be stored. Alternatively, you can use a service like Dropbox to host the files.

Ensure the URL to your document ends with the format of the file eg. .pdf or .jpg. URLs ending in .html or .php won't work.

!(Alternative text describing the image](http://www.example.com/logo.png)

[!(Alternative text describing the image](http://www.example.com/logo.png)](http://example.com/)

 

Tip: If using Dropbox, alter the ending URL so it finishes with "?raw=1" to ensure the images embed as you are expecting

Want more? Check out the official and complete markdown syntax guide. (Note: Award Force does not support all markdown at this stage. If in doubt, please ask!