Markdown Rules

Wiki

Markdown Rules

Scripting wiki entries are formatted using markdown and markdown extra. Both markdown and markdown extra are easy-to-read and easy-to-write. Also see the compose tips.

A quick guide to the most basic and useful elements of markdown syntax follows.

Block Elements

Paragraphs

A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines.

Headers

Headers may be formatted in two ways. The header Setext style is:

This is an H1 heading
=====================
This is an H2 heading
---------------------

The atx header style uses a # prefix to indicate the header level:

# So this is an H1
## This is and H2
##### While this is an H5

Blockquotes

Blockquotes are formatted using an email-style > character:

> Uses block quotes as you would in an email client
>
> Yes, it's easy.

Lists

Both ordered and unordered lists are supported. Unordered lists make use *, + or _ as list markers:

* AppleScript
* F-Script
* C++

Ordered lists use numbers followed by periods:

1. JSCocoa
2. LuaCocoa
3. Py-ObjC

Code Blocks

Pre-formatted code blocks are preceded by at least four spaces or 1 tab character:

I am a text block

    # I am indented and will be rendered
    # as pre formatted code.

Inline Elements

Links

Two styles of link formatting are supported: inline and reference. The inline style uses square brackets for the link title followed by the URL in parentheses:

This is [one good link](http://www.mugginsoft.com), don't you think!

Reference style links use two sets of square brackets. The second contains a label identifying the link:

This is [one good link][the-good-link], don't you think!

The label is then defined anywhere in the document on a line of its own:

[the-good-link]: http://www.mugginsoft.com

Emphasis

Both asterisks(*) and underscores(_) are used to indicate emphasis. A single occurrence renders as an <em> tag, a double occurrence as <strong>:

*I am emphasized*
_So am I_
**I am strong**
__I am strong too__

Code

A span of code is indicated using the back tick character `:

To end the application simply call the `exit()` function with no arguments.

Automatic Links

URLs and email addresses can be rendered into links automatically by surrounding them with angle brackets:

<http://www.mugginsoft.com>
<support@mugginsoft.com>