---
title: Markdown Syntax Guide
description: Tables, math, code blocks, task lists and every other syntax Markflow understands — with copyable examples.
date: 2026-11-10
updated: 2026-11-10
order: 20
tags: [syntax]
---

# Markdown Syntax Guide

Markflow renders **GitHub Flavored Markdown** with KaTeX math and syntax-highlighted code blocks. This guide shows each construct with a copyable example.

## Headings

Start a line with 1–6 `#` characters followed by a space. Headings build the outline panel and the table of contents on this site.

## Emphasis

```markdown
**bold**  *italic*  ~~strikethrough~~  `inline code`
```

Renders as: **bold**, *italic*, ~~strikethrough~~, `inline code`.

## Lists

### Bullet and numbered

```markdown
- First item
- Second item
  - Nested item

1. Step one
2. Step two
```

### Task lists

```markdown
- [x] Shipped feature
- [ ] Write documentation
```

- [x] Shipped feature
- [ ] Write documentation

## Tables

Colons in the separator row control alignment:

```markdown
| Feature | Shortcut | Status |
| :--- | :---: | ---: |
| Find & replace | Ctrl / ⌘ + H | Ready |
| Focus mode | Ctrl / ⌘ + Shift + F | Ready |
```

## Code blocks

Name the language after the fence to get highlighting:

````markdown
```ts
type Writer = {
  name: string;
  published: number;
};

const writer: Writer = { name: 'Markflow', published: 12 };
console.log(`Hello, ${writer.name}`);
```
````

## Math

Inline math uses single `$...$` and display math uses `$$...$$`:

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

Inline example: the famous $E = mc^2$.

## Quotes and alerts

```markdown
> A quote worth keeping.
```

> A quote worth keeping.

GitHub-style alert callouts are also supported:

```markdown
> [!TIP]
> Export downloads Markdown, standalone HTML, or prints to PDF.
```

> [!TIP]
> Export downloads Markdown, standalone HTML, or prints to PDF.

## Diagrams (Mermaid)

```mermaid
graph TD
    A[Start writing] --> B{Use a template?}
    B -- Yes --> C[New from template]
    B -- No --> D[Blank page]
    C --> E[Enjoy live preview]
    D --> E
```

Wrap the diagram source in a ```mermaid fence to render flowcharts, sequence diagrams and more (see above).

## Links and anchors

Standard links work as usual — `[text](https://example.com)`. Links starting with `#` jump to headings inside the same document, e.g. [back to headings](#headings).

## What is *not* supported

By default, raw HTML in your Markdown is **not** rendered (scripts and unknown markup are stripped to keep previews safe). You can allow a sanitized whitelist in *Preferences → Editing → Render safe HTML*.
