TLD markdown example

The markdown will support
Bold Text
Underlined Text
Italicised Text
Strike-through Text
Pre-formatted Text

  1. Ordered
  2. List
  3. Items
  • Unordered
  • List
  • Items

Which should be suitable for most people and most uses. After all, it is just documentation (and tag library documentation at that!).

Bold text

starting with a double asterisk at the start of the area to the end of the area. This area must be on one line.

For the following markup:

this surrounding text will not have any formatting applied to it **This text will be bold** this surrounding text will not have any formatting applied to it

The output would be :

this surrounding text will not have any formatting applied to it This text will be bold this surrounding text will not have any formatting applied to it

Underlined text

starting with a double underline at the start of the area to the end of the area. This area must be on one line.

For the following markup:

this surrounding text will not have any formatting applied to it __This text will be underlined__ this surrounding text will not have any formatting applied to it

The output would be:

this surrounding text will not have any formatting applied to it This text will be underlined this surrounding text will not have any formatting applied to it

Strikethrough text

starting with a double minus sign at the start of the area to the end of the area. This area must be on one line.

For the following markup:

this surrounding text will not have any formatting applied to it --This text will be struck through-- this surrounding text will not have any formatting applied to it

The output would be:

this surrounding text will not have any formatting applied to it This text will be struck through this surrounding text will not have any formatting applied to it

Italicised text

starting with a double forward slash at the start of the area to the end of the area. This area must be on one line.

For the following markup:

this surrounding text will not have any formatting applied to it //This text will be italicised// this surrounding text will not have any formatting applied to it

The output would be:

this surrounding text will not have any formatting applied to it This text will be italicised this surrounding text will not have any formatting applied to it

Pre-formatted text

starting with a double equals sign ‘=’ and ending with the same. All content within this area will be rendered exactly as it appears.

For the following markup:
==
This area will all be pre-formatted, with new lines,
tabs and
indentation, exactly how it appears. Note that the last of the new line characters will not be used unless there is a space.

==
This text will go back to the normal text.

The output would be:


This area will all be pre-formatted, with new lines,
tabs and
indentation, exactly how it appears. Note that the last of the new line characters will not be used unless there is a space.

This text will go back to the normal text.

  • Unordered list items1:

The first non whitespace character must be a minus sign (-) followed by a space.

For the following markup:

-
- this will be an unordered list item
- this too will be an unordered list item
-

The output would be:

  • this will be an unordered list item
  • this too will be an unordered list item

This will end the unordered list

-this however will not be an unordered list item as it has the minus sign, but not the space after it

  1. Ordered list items

The first non whitespace character must be a plus sign (+) followed by a space.

If the only thing on the line is a plus character (+) then the ordered list will start

For the following markup:

+
+ this will be an ordered list item
+ this too will be an ordered list item
+
This will end the ordered list

+this however will not be an ordered list item as it has the plus sign, but not the space after it

The output would be:

  1. this will be an ordered list item
  2. this too will be an ordered list item

New paragraphs, should there be a line with only whitespace on it, it will create a new paragraph.

Footnotes:

  1. The unordered/ordered list item may be changed to allow nesting of lists – however I am getting ahead of myself

Like my footnotes?
Want to add footnotes to your blog?
They can be added easily to your WordPress installation