Markdown Code

From WikiOD

Syntax[edit | edit source]

  • inline: `Code between backticks` or <code>Code between these HTML tags</code>
  • multiline: ____Code that is indented on each line or <pre><code>Multiple lines of code between these HTML tags</code></pre>

Inline code[edit | edit source]

Markdown supports adding inline code like this, obtained by wrapping text in backticks:

`code here`

Alternatively, you can put your inline code between <code> and </code> HTML tags.

Consider the following markdown code:

`This` is an inline code block! <code>This</code> is one too!

That would produce the following output:

This is an inline code block! This is one too!


If you need to include a backtick inside inline code, you can use multiple backticks to begin and end the inline code block, like this:

``code containing a backtick (`) character``

That would produce the following output:

code containing a backtick (`) character


Use \ to escape backticks. For example:

\`a\`

will be rendered as

`a`

Syntax highlighting (StackExchange)[edit | edit source]

On StackExchange sites, code snippets may provide optional syntax highlighting. On sites like Stack Overflow the default language is derived from the tags used in the associated question (if applicable). In addition, a code snippet's syntax highlighting language may also be defined by adding an HTML comment to the text body.

<!** language: lang-vb -->

    Sub ShowVB()
    Dim i As Long
    For i = 1 To 2
        If i = 3 Then
            MsgBox "How did that happen?"
        End If
    Next
    End Sub

Such a comment will change the syntax highlighting language for all subsequent code snippets, which can be rather useful, especially when several languages are involved in one post.

The above will be rendered with Visual Basic highlighting as:

Sub ShowVB()
Dim i As Long
For i = 1 To 2
    If i = 3 Then
        MsgBox "How did that happen?"
    End If
Next
End Sub

Fenced Code Blocks[edit | edit source]

Some parsers allow code to be designated by adding three backticks before and after a section of code.

```
<p><em>This</em> is an HTML example!</p>
```

Optionally, many parsers allow adding syntax highlighting by specifying the code's language immediately after the first set of backticks:

```html
<p><em>This</em> is an HTML example!</p>
```

Result:

<p><em>This</em> is an HTML example!</p>

Indented code blocks inside lists[edit | edit source]

When adding indented code blocks inside a list you first need a blank line, then to indent the code further. Different flavours of Markdown have different rules for this.

StackExchange requires code to be indented by 8 characters instead of the usual 4. (Spaces replaced with * for clarity):

 1.*Listitem1
 2.*Listitem2

 ********code here
 3.*Listitem3

Specs such as CommonMark require that the code block be indented 4 characters from where the list item text starts. (Spaces replaced with * for clarity):

 1.****Listitem1
 2.****Listitem2

 **********code here
 3.****Listitem3

Indented code blocks[edit | edit source]

You can create multiline code snippets by indenting each line with at least four spaces or one tab:

    #include <stdio.h>

    int main() {
      printf("Hello World!\n");
      return 0;
    }

Credit:Stack_Overflow_Documentation