Using markdown

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.

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.".

Quick reference

General formatting

**Bold text**
*Emphasis / italic text*

Paragraph breaks simply need two spaces at the end of a sentence/paragraph followed by two carriage returns. A horizontal line can be done with 3 hyphens followed by two spaces like this:

---  

Lists

- Bulleted (unordered) lists
- Use a hyphen for each bullet
- Like this

1. Numbered lists
2. Preface each line of text with a number and point
3. Like this

Headings

# A first level (large) heading
## A second level (medium) heading
### A Third level (small) heading

Links

Create a link by putting the link text in brackets and the URL in parentheses,
like [this](http://www.awardforce.com)

Video embedding

Videos can be embedded using a variation of markdown image embedding syntax:

![600](https://vimeo.com/135510971)

  • 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

Inline image syntax looks like this:

![Alt text](https://www.google.com/bear)

![Alt text](https://www.google.com/bear "Optional title")

That is:

  • An exclamation mark: !;
  • followed by a set of square brackets, containing the alt attribute text for the image;
  • followed by a set of parentheses, containing the URL or path to the image, and an optional title attribute enclosed in double or single quotes.

The official and complete markdown syntax guide

Was this article helpful?
2 out of 3 found this helpful

Comments

0 comments

Article is closed for comments.