Code

Code blocks or snippets—as shown in Example 6—are created by enclosing the code for display in triple back-ticks (`), this is commonly referred to as fenced code blocks. Two requirements exist for creating the code blocks:

1. the back-ticks must be proceeded by an empty line and

2. the back-ticks must start at the beginning of a line.

Settings for code blocks are defined by key-value pairings that follow the back-ticks; Table 3 lists the available settings for code blocks.

```language=bash
export METHOD=opt
```

Quotations

Quotation blocks are created by starting a line with the > character, with a single trailing space as shown in Example 7. Then each additional line that belongs within the quotation must also begin with a > character. Within the quotations any valid markdown is acceptable, as shown in Example 8.

> This is a quotation.

> Quotations begin with the `<` character and may
> contain any valid markdown content, include quotes and code as shown here.
>
> > This begins another quotation, which also contains a fenced code block.
> >
> > ```language=python
> > for i in range(10):
> >   print i
> > ```
>
> Since quotations are block content they must end with an empty line,
> therefore the nested quote above must contain an empty line.

Headings

Headings can range from level one to six and are specified using the hash (#) character, where the number of hashes indicate the heading level (see Example 9). The following is required to define a heading:

1. the hash(es) must be followed by a single space,

2. the hash(es) must not be proceeded by a space.

Settings, as listed in Example 10, are be applied after the heading title text and as shown in Example 11 headings may also span multiple lines.

# Level One

## Level Two

### Level Three

#### Level Four

##### Level Five

###### Level Six

## Level Two style=font-size:75pt;color:red; id=level-two

## A Heading May Span

Multiple Lines (this is useful if they are really long) style=font-size:15pt id=level-two

Unordered List

Unordered list items in MooseDown must begin with a dash (-), as shown below in Example 12. As with any block item, a list must be proceeded and followed by an empty line. However, lists have additional behavior that allow for nested content to be included.

1. An empty line will not stop the list if the following line begins with another list marker (i.e., -), in this case the list continues.

2. An empty line followed by a non-list marker—everything except a hyphen—will stop the list. Otherwise, a list will stop if two empty lines are encountered, otherwise it will continue to add items to the current list.

List items may contain lists, code, or any other markdown content and the item content may span many lines. The continuation is specified by indenting the content to be included within the item by two spaces, as shown in Example 13.

- Item 1
- Item 2

- Item with code
  Content can be contained within a list, all valid MooseDown syntax can be used.

  ```
  int combo = 12345;
  ```

- Another item

• Foo

  
  bar
  

As mentioned above, lists can contain lists, which can contain lists, etc. A sub-list, which is a list in a list, is created by creating by indenting with at the level of the list item which is should contained. Since lists are block items, it must be begin and end with empty lines. And, since this is a list it also follows the aforementioned rules for list continuation. Example 14 demonstrates the syntax for creating nested lists.

- A
- B

  - B.1
  - B.2

    - B.2.1
    - B.2.2

  - B.3

    - B.3.1

      - B 3.1.1

    - B.3.2

  - B.4

- D

Ordered List

A numbered list work nearly identical to unordered lists (see ), but start with a numbered followed by a period and a single space. The number used for the first item in the list will be the number used for the start of the list, see Example 15.

42. Foo
1. Bar


1. Another list that contains nested content.

   1. Ordered lists can be nested and contain markdown.

      ```
      code
      ```

Shortcuts

It is possible to define shortcuts for use within your document via a shortcut link. The shortcuts are defined using traditional markdown syntax as in . However, these are block items, so to maintain consistent behavior they must be surrounded by blank lines.

You can create shortcuts to common items: [foo].

[foo]: bar

Monospace (Inline Code)

Monospaced text is specified by encasing the text with single back-ticks, the content within the back-ticks is reproduced verbatim, thus allowing for MooseDocs syntax to be enclosed within the back-ticks, as in Example 17.

The following MooseDocs `[google]` will show verbatim because it
is enclosed within back-ticks, without the back-ticks [google] creates a link.

[google]: https://www.google.com

Text Formatting

Inline text formatting differs in MooseDocs from traditional markdown in many ways, the reasons for the differences include avoiding reusing the same symbol (i.e., *) for multiple formats, making the syntax suitable to simple parsing of multiline regions, and to support a wide range of formats.

For all formats the starting character must be immediately followed by a non-whitespace character. The starting character must alwo be proceeded by a whitespace, except in the case of the super and subscript which must be proceecded by a non-whitespace character. The ending character must be immediately proceeded by a non-whitespace character. The following table lists the available formats with start and end characters.

The formatting can be arbitrarily nested and span multiple lines within the same paragraph, thus as shown in Example 18, complicated and compound formatting of text is possible.

Yo, dawg I heard you like formatting, so I created =underline
formatted text that contains text with ~stikethrough that
contains +bold formatting with *emphasis that has some^superscript
text with a@subscript@^*+~=, I hope you like it.

Links

MooseDocs uses traditional markdown syntax for links; however, it also supports settings within the link (see Example 5). The settings are the expected key-value pairings common to much of the MooseDocs syntax. The available settings for links is include in Table 5.

Shortcut links

Links to shortcuts use the typical markdown syntax of a key enclosed in square brackets ([key]), where the key references a shortcut, which are defined as detailed in the section, refer to Example 16 for a demonstration of shortcut and shortcut link use.

In addition to linking to created directly, the same syntax is used to reference headings that have an "id" setting applied, see Example 19. When used in this fashion the heading text directly replaces the shortcut link and a link to the heading is created.

Using shortcut link syntax, it is possible to link to [heading].

# A Heading with Link id=heading

Punctuation

When rendering HTML, MooseDocs converts the following punctuation to the correct symbols, the table below lists the conversions that are performed.