Markdown Reference

Markdown Reference

mdedit.io uses CommonMark as its base, extended with GitHub Flavored Markdown (GFM), Pandoc extensions, and mdedit-specific features.

Basic Syntax

Headings

# Heading 1
## Heading 2
### Heading 3

Emphasis

**bold**   _italic_   ~~strikethrough~~   ==highlight==

Lists

- Unordered item
- Another item
  - Nested item

1. Ordered item
2. Second item

Links and Images

[Link text](https://example.com)
![Alt text](image.png)
![Alt text](image.png){ width=60% }

Tables

| Column 1 | Column 2 |
|---|---|
| Cell | Cell |

Code

Inline `code` and fenced blocks:

```python
def hello():
    print("Hello")

### Blockquotes

```markdown
> This is a blockquote.

Horizontal Rule

---

Extended Syntax

Footnotes

Text with a footnote.[^1]

[^1]: The footnote content.

Definition Lists

Term
: Definition text.

Task Lists

- [x] Completed
- [ ] Open

Math (KaTeX)

Inline: $E = mc^2$

Block:
$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$

Mermaid Diagrams

```mermaid
graph TD
  A[Start] --> B[Process] --> C[End]
```

mdedit-Specific Features

Table of Contents

[[toc]]

Page Break

<!-- page-break -->

Columns Layout

:::: columns
::: column
Left column content
:::
::: column
Right column content
:::
::::

Title Page Block

::: title-page
# My Title {.no-toc}
## Subtitle {.no-toc}
**Author** · Institution · Date
:::

Section IDs (for cross-references)

## My Section {#sec:intro}

See [@sec:intro] for details.

Number Sections (YAML front matter)

---
number-sections: true
---

YAML Front Matter

---
title: "Document Title"
author:
  - Author Name
date: 2026-05-12
lang: en-US
preset: scientific
number-sections: true
citation-source: embedded
reference-section-title: References
link-citations: true
---

See Also

• Layout Presets
• Citations and References
• Keyboard Shortcuts