Markdown submission formatting guide

We ask that you submit your contributions using formatting called markdown. Markdown is a plain text formatting syntax that allows us to easily convert it to various formats and to apply the main document styling at a later date.

To this end, Markdown’s syntax is comprised entirely of punctuation characters, which punctuation characters have been carefully chosen so as to look like what they mean. E.g., asterisks around a word actually look like emphasis. Markdown lists look like, well, lists. John Grubber (Creator of Markdown)

Markdown allows you, the Author, to concentrate on the text you are writing rather than the format of the document.

Below is a guide to Markdown with examples on the left and the resulting HTML and styled result on the right.


Paragraphs

Paragraphs of text are just that. They are surrounded a blank line above and below but otherwise will just run and run

An example block of text i.e. this is a paragraph and this is the first of two.

An example block of text i.e. this is a paragraph and this is the first of two.


This is the second paragraph of two as there is a blank line between me and the last one
however a single new line without a blank line will be part of the same paragraph.

This is the second paragraph of two as there is a blank line between me and the last one however a single new line without a blank line will be part of the same paragraph.


Bold and italic formatting of words / phrases

Use a double asterix (**) or double underscore (__) around a **word** or __phrase to make it bold__.

Use a double asterix (*) or double underscore (__) around a *word or phrase to make it bold.


And use a single asterix (*) or underscore (_) character in the same way to make a *word* or _a phrase italic_.

And use a single asterix (*) or underscore (_) character in the same way to make a word or a phrase italic.


Headings

Use the hash '#' characters to define the level of heading. We reserve the top level i.e. single hash for titles so please use only level 2 and below

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Lists

Lists can be numbered or just bullet pointed.

1. Item 1
2. Item 2
1. Item 3
1. Item 4
  1. Item 1
  2. Item 2
  3. Item 3
  4. Item 4

Notice that is does not actually matter what number you use for the item. The items will be ordered consuctutively.

Unordered lists are consturcted using any one of -, + or * in front of the item

- Item 1
- Item 2
- Item 3
- Item 4
  • Item 1
  • Item 2
  • Item 3
  • Item 4

Blockquotes

Sections of text can be highlighted as a quote or used to emphasis a paragraph. Prefix each line with the great than > character

> An important fact to draw the readers attention to
> in the text

An important fact to draw the readers attention to in the text


Pictures

To include a picture the format is exclamation mark followed by a description in square brackets and then the image file name in side of round brackets

I.e

![A description of the picture](picture filename)

![Pills](/images/pills.jpg)

Pills


Tables

Tables can be added using the pipe and dash characters. The colons next to the dashes set the alignment of text within the cells


| Header 1          | Header 2      | Header 3           |
| ----------------- |:-------------:| ------------------:|
| Left aligned cell | Centered Cell | Right aligned Cell |
| Row 2             | Row 2         | Row 2              |
Header 1 Header 2 Header 3
Left aligned cell Centered Cell Right aligned Cell
Row 2 Row 2 Row 2

Example

Finally here is an example of a docuemnt formatted with Markdown to see all these items in action

## Eadem nunc mea adversum.
 
Lorem ipsum **dolor sit** amet, _consectetur adipiscing_ elit. Ita fit cum gravior,
tum etiam splendidior oratio. Nunc ita separantur, ut disiuncta sint, quo nihil
potest esse perversius. Philosophi autem in suis lectulis plerumque moriuntur.
 
- Primum in nostrane potestate est, quid meminerimus?
- Hoc loco tenere se Triarius non potuit.
- Duo Reges: constructio interrete.
- At certe gravius.
 
### Ego vero volo in virtute vim esse quam maximam.
 
Negat enim summo bono afferre incrementum diem. An vero, inquit, quisquam potest probare,
quod perceptfum, quod. Et quidem, inquit, vehementer errat;
 
1. Sed haec quidem liberius ab eo dicuntur et saepius.
2. Nam aliquando posse recte fieri dicunt nulla expectata nec quaesita voluptate.
1. Eam tum adesse, cum dolor omnis absit;
7. Omnis enim est natura diligens sui. At quicum ioca seria, ut dicitur, quicum arcana.
 
![Pills](/images/pills.jpg)
 
|  Dicut          |  Incrementum    |
|-----------------|-----------------|
| Etiam elementum | Fringilla justo |
| ullamcorper | consectetur urna |

Eadem nunc mea adversum.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ita fit cum gravior, tum etiam splendidior oratio. Nunc ita separantur, ut disiuncta sint, quo nihil potest esse perversius. Philosophi autem in suis lectulis plerumque moriuntur.

  • Primum in nostrane potestate est, quid meminerimus?
  • Hoc loco tenere se Triarius non potuit.
  • Duo Reges: constructio interrete.
  • At certe gravius.

Ego vero volo in virtute vim esse quam maximam.

Negat enim summo bono afferre incrementum diem. An vero, inquit, quisquam potest probare, quod perceptfum, quod. Et quidem, inquit, vehementer errat;

  1. Sed haec quidem liberius ab eo dicuntur et saepius.
  2. Nam aliquando posse recte fieri dicunt nulla expectata nec quaesita voluptate.
  3. Eam tum adesse, cum dolor omnis absit;
  4. Omnis enim est natura diligens sui. At quicum ioca seria, ut dicitur, quicum arcana.

Pills

Dicut Incrementum
Etiam elementum Fringilla justo
ullamcorper consectetur urna