Markdown Support

We support all standard Markdown features, based on GitHub-flavored Markdown (GFM).

Headings

Use one to six # characters to create headings from level one through six.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Text Formatting

Emphasize text with bold, italic, strikethrough, and inline code.

**Bold text**

*Italic text*

~~Strikethrough text~~

`Inline code`

Lists

Create unordered lists with - and nest items by indenting them.

- Unordered list item
- Another item
  - Nested item
  - Another nested item

Create ordered lists with numbers, nesting items the same way.

1. Ordered list item
2. Another item
   1. Nested item
   2. Another nested item

Links and Images

Link to absolute URLs, other Markdown files, and embed images.

Absolute URLs

Relative link

[Absolute URLs](https://example.com)
[Relative link](/products/docs/components/tables)
![Image](https://docs.scalar.com/scalar-docs.png)

Code Blocks

Wrap code in fenced blocks and add a language for syntax highlighting.

function example() {
  return "Hello, World!";
}

```javascript
function example() {
  return "Hello, World!";
}
```

Blockquotes

Quote text with >, spanning multiple lines as needed.

> This is a blockquote
>
> It can span multiple lines

Tables

We support standard GitHub-flavored Markdown tables.

| Header 1 | Header 2 | Header 3 |
| -------- | -------- | -------- |
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

For alignment, escaping pipe characters, and best practices, see Tables.

Task Lists

Track work with checkboxes using - [ ] for open items and - [x] for completed ones.

- [x] Completed task
- [ ] Pending task
- [ ] Another pending task

Hints

We support GitHub-style alerts for highlighting important information.

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.