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

Award Force makes use of markdown for text 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."

General formatting

General_formatting.png

Lists

 Lists.png

Note: Lists are not supported in labels. You will need to use the hint box instead.
Headings
Headings.png
Note: You can add a row of equal signs (=) under a line of text to create Heading level one, or a row of dashes (-) under a line of text to create a Heading level two.
Link to a website/email address

Links.png

Link to a document

Documents, images and videos need to be hosted somewhere before they can be linked or embedded. For example, you may have a marketing website or intranet where these files can be stored. Or 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.

document.png

Video embedding

Firstly, the video file needs to be hosted. 

Documents, images and videos need to be hosted somewhere before they can be linked or embedded. For example, you may have a marketing website or intranet where these files can be stored. Or 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.

Video.png

  • The number in square brackets defines the width to display the video at.
  • 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

Firstly, the image file needs to be hosted. 

Documents, images and videos need to be hosted somewhere before they can be linked or embedded. For example, you may have a marketing website or intranet where these files can be stored. Or 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.

Image.png

The official and complete markdown syntax guide