Markdown Code Block Syntax

Inline Code

Wrap a short code snippet or command in single backticks ( `code`). Inline code ignores Markdown formatting inside it, so asterisks and brackets appear literally.

Use `console.log()` for quick feedback.

Fenced Code Blocks

Use three backticks before and after the code. Put the opening fence on its own line. The closing fence must also be on its own line and use the same number of backticks.

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}

console.log(greet("World"));
```

function greet(name) {
  return `Hello, ${name}!`;
}

console.log(greet("World"));

Language Identifiers

Add a language tag after the opening backticks so the renderer can apply syntax highlighting. The tag must touch the backticks with no space. Common tags: javascript, python, bash, json, html, css, sql.

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"
```

def greet(name: str) -> str:
    return f"Hello, {name}!"

```
Some plain text
inside a code block
```

Some plain text
inside a code block

Indented Code Blocks

Indent every line by at least four spaces or one tab to create a code block. This is the original CommonMark way. It has no language identifier and is useful inside list items where fenced blocks can be tricky.

    function greet(name) {
      return `Hello, ${name}!`;
    }

    console.log(greet("World"));

function greet(name) {
  return `Hello, ${name}!`;
}

console.log(greet("World"));

GitHub Callouts

GitHub extends blockquotes with alert callouts. Start a blockquote with > [!TYPE] where TYPE is NOTE, TIP, IMPORTANT, WARNING, or CAUTION. They render as colored blocks with icons.

> [!NOTE]
> This is a GitHub alert callout inside a code-friendly doc.

Diff Code Blocks

Use the diff language identifier to show code changes. Lines starting with - render as removed (red) and lines starting with + render as added (green).

```diff
- const oldValue = 1;
+ const newValue = 2;
```

- const oldValue = 1;
+ const newValue = 2;

Discord Code-Block Colors

Discord does not do true syntax highlighting, but you can produce colored text by using specific language identifiers with matching patterns. Use these for decoration, not for accurate language support.

```diff
- This text appears red
+ This text appears green
```

```fix
This text appears yellow/orange
```

```ini
[This text appears blue]
```

Common Mistakes

The five most common reasons a Markdown code block fails. Each row shows the broken version and the corrected one side by side.

``` javascript

```javascript

```
code
`````

```
code
```

```js
const x = 1;

```js
const x = 1;
```

```python
code line 1
code line 2
```

    code line 1
    code line 2

Use console.log() for output

Use `console.log()` for output

Quick Reference

Platform Support

Code blocks are core Markdown syntax, so support is broad. The main differences are language-tag handling, syntax highlighting, and whether language identifiers are used for color tricks.

Frequently Asked Questions