Markdown - Complete Reference

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

Heading 1
=========
 
Heading 2
---------

^ Heading 1  (if enabled in settings)
^^ Heading 2
^^^ Heading 3

This is a paragraph. Just write normally.
 
Leave a blank line to start a new paragraph.
 
This is another paragraph.

Method 1: Two spaces at end of line
Then next line.
 
Method 2: Backslash at end\
Then next line.
 
Method 3: HTML break<br>Then next line.

**bold text**
__also bold__

*italic text*
_also italic_

***bold and italic***
___also bold and italic___
**_mixed formatting_**

~~strikethrough text~~

<u>underlined text</u>

==highlighted text==

Use `backticks` for inline code.
 
Code with backticks: ``use `backtick` in code``

`var code = "javascript"`{.js}
`print("python")`{.python}

- Item 1
- Item 2
  - Nested item 2.1
  - Nested item 2.2
    - Deeply nested 2.2.1
- Item 3
 
* Alternative syntax
* Works the same
  * Can mix styles
  - Like this

1. First item
2. Second item
   1. Nested item
   2. Another nested
3. Third item
 
Start from different number:
5. Fifth item
6. Sixth item

- [ ] Unchecked task
- [x] Checked task
- [>] Forwarded task
- [<] Scheduled task
- [-] Cancelled task
- [?] Question/Uncertain
- [!] Important task
- [*] Star/Bookmark

- [ ] Task @due(2025-01-30) #priority/high
- [x] Completed task @done(2025-01-23)
- [ ] Task with subtasks
  - [x] Subtask 1
  - [ ] Subtask 2

Term 1
: Definition 1
 
Term 2
: Definition 2a
: Definition 2b
 
HTML Terms
: Hypertext Markup Language
 
CSS Terms
: Cascading Style Sheets

[Link text](https://example.com)
[Link with title](https://example.com "Link Title")
<https://autolink.com>
<email@example.com>

[Link text][reference]
[Another link][ref2]
 
[reference]: https://example.com
[ref2]: https://example2.com "Optional Title"

[[Note Title]]
[[folder/Note Title]]
[[Note Title|Display Text]]
[[Note Title#Heading]]
[[Note Title#^block-id]]

Shortest: [[note]]
Absolute: [[/folder/subfolder/note]]
Relative: [[../folder/note]]
With Alias: [[note|Alias Text]]
With Heading: [[note#Section]]
With Block: [[note#^block123]]

[Link to heading](#heading-id)
[Link to section](#section-name)

![Alt text](image.png)
![Alt text](https://example.com/image.jpg "Image Title")
![](image.png)

![Image](image.png){width=300px}
![Image](image.png){height=200px}
![Image](image.png){width=50%}

![Image](image.png){.center}
![Image](image.png){.left}
![Image](image.png){.right}

![[image.png]]
![[folder/image.png|Alt Text]]
![[image.png|300]]
![[image.png|300x200]]

![Alt text](image.png)
*Image caption goes here*
 
Or with HTML:
<figure>
  <img src="image.png" alt="Alt text">
  <figcaption>Image caption</figcaption>
</figure>

```
Basic code block
No syntax highlighting
```
 
```javascript
// JavaScript with highlighting
const greeting = "Hello, World!";
console.log(greeting);
```
 
```python
# Python with highlighting
def hello():
    print("Hello, World!")
```

100+ languages including:
- javascript, typescript, jsx, tsx
- python, java, c, cpp, csharp, go, rust
- html, css, scss, less
- sql, graphql, yaml, json, xml
- bash, shell, powershell
- markdown, latex, dockerfile
- ruby, php, swift, kotlin
- and many more...

```javascript {1,3-5}
// Highlight lines 1, 3, 4, 5
const a = 1;
const b = 2;
const c = 3;
const d = 4;
const e = 5;
```
 
```python {numberLines: true}
# Show line numbers
def function():
    pass
```
 
```javascript title="filename.js"
// Show filename
console.log("code");
```

```javascript exec
// Executable code block (if enabled)
return 2 + 2;
```

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

| Left    | Center  | Right   |
|:--------|:-------:|--------:|
| Left    | Center  | Right   |
| aligned | aligned | aligned |

| Feature | Supported | Notes |
|---------|:---------:|-------|
| Bold | Yes | Use **bold** |
| Italic | Yes | Use *italic* |
| Code | Yes | Use `code` |
| Links | Yes | [link](url) |
| Images | No | Not in tables |

| Col 1 | Col 2 | Col 3 |
|-------|-------|-------|
| Span across cols || |
| Normal | Cell | Cell |

> This is a blockquote.
> It can span multiple lines.
 
> Another blockquote.
>
> With multiple paragraphs.

> First level
>> Second level
>>> Third level
 
> Back to first level

> **Bold** and *italic* work.
>
> - Lists work too
> - Another item
>
> ```code
> Code blocks work
> ```

>[!note]
>This is a note callout.
 
>[!tip]
>Helpful tip here.
 
>[!warning]
>Important warning message.
 
>[!danger]
>Critical information!

>[!note] | >[!info] | >[!todo]
>[!tip] | >[!hint] | >[!success]
>[!question] | >[!help] | >[!faq]
>[!warning] | >[!caution] | >[!attention]
>[!danger] | >[!error] | >[!bug]
>[!example] | >[!quote] | >[!cite]

>[!tip] Pro Tip
>Custom title for your callout.
>Multiple paragraphs supported.
 
>[!warning] Before You Proceed
>Read this carefully.

>[!note]- Click to Expand
>This content is hidden by default.
>Click the title to reveal.
 
>[!tip]+ Expanded by Default
>This is visible.
>Can be collapsed.

Einstein's equation: $E = mc^2$
 
Quadratic formula: $x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}$
 
Greek letters: $\alpha, \beta, \gamma, \delta$

$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$
 
$$
\begin{aligned}
f(x) &= x^2 + 2x + 1 \\
&= (x + 1)^2
\end{aligned}
$$

Fractions: \frac{numerator}{denominator}
Square root: \sqrt{x}
Powers: x^2, x^{10}
Subscripts: x_1, x_{10}
Summation: \sum_{i=1}^{n} i
Integral: \int_a^b f(x) dx
Limits: \lim_{x \to \infty} f(x)
Matrices:
\begin{matrix}
a & b \\
c & d
\end{matrix}

---
 
***
 
___
 
- - -
 
* * *

X^2^           Superscript
H~2~O          Subscript
E=mc^2^        Einstein
CH~3~CH~2~OH   Chemical formula

Here's a sentence with a footnote[^1].
 
Another sentence[^note].
 
[^1]: This is the footnote.
[^note]: Named footnotes work too.

The HTML specification is maintained by W3C.
 
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

::: container-name
Content goes here
:::
 
::: warning
Important warning
:::
 
::: {.custom-class #custom-id}
With class and ID
:::

<div class="custom">
  Markdown **still** works here
</div>
 
<span style="color: red">Red text</span>
 
<details>
  <summary>Click to expand</summary>
  Hidden content
</details>

\* Escaped asterisk
\_ Escaped underscore
\` Escaped backtick
\# Escaped hash
\[ Escaped bracket
 
Use backslash to escape markdown syntax

<!-- HTML comments work -->
<!-- They won't appear in rendered output -->
 
[//]: # (Alternative comment syntax)
[//]: # (Also hidden)
 
%%Obsidian-style comments%%
(If enabled in settings)

---
title: Note Title
date: 2025-01-23
tags:
  - tag1
  - tag2
author: Author Name
description: Note description
---

+++
title = "Note Title"
date = 2025-01-23
tags = ["tag1", "tag2"]
+++

;;;
{
  "title": "Note Title",
  "date": "2025-01-23",
  "tags": ["tag1", "tag2"]
}
;;;

![[Other Note]]
![[Other Note#Section]]
![[Other Note^block-id]]

![[document.pdf]]
![[document.pdf#page=5]]

![[audio.mp3]]
![[video.mp4]]
![](https://youtube.com/watch?v=...)

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Result 1]
    B -->|No| D[Result 2]
```
 
```mermaid
sequenceDiagram
    Alice->>Bob: Hello!
    Bob->>Alice: Hi!
```
 
```mermaid
gantt
    title Project Timeline
    dateFormat YYYY-MM-DD
    section Phase 1
    Task 1: 2025-01-01, 30d
```

URLs automatically become links:
https://example.com
 
Emails too:
email@example.com

"Smart quotes"
'Single quotes'
en--dash
em---dash
ellipsis...

:smile: :heart: :thumbsup:
:rocket: :fire: :star:
 
Or Unicode emojis

Press <kbd>Cmd</kbd> + <kbd>K</kbd>
 
<kbd>Ctrl</kbd> + <kbd>C</kbd> to copy

1. Editing Mode: Edit raw markdown
2. Live Preview: WYSIWYG editing
3. Reading Mode: Rendered view only

Toggle: Cmd+E

View markdown and preview side-by-side
- Left: Markdown source
- Right: Rendered preview
- Synchronized scrolling

Enable: Cmd+\

Export markdown to:
- PDF: Print-ready documents
- HTML: Web pages
- DOCX: Word documents
- Plain MD: Standard markdown
- With/without extensions

Choose markdown flavor for export:
- Standard Markdown
- GitHub Flavored Markdown (GFM)
- CommonMark
- Pandoc Markdown
- Lokus Extended (all features)

Yes Use headings hierarchically (don't skip levels)
Yes Leave blank lines between sections
Yes Use consistent list markers
Yes Close all code blocks properly
Yes Use descriptive link text
Yes Add alt text to images

No Don't over-nest lists (3 levels max)
No Don't use raw HTML excessively
No Don't forget to escape special characters
No Don't mix tab and space indentation

For large documents:
- Use section folding
- Enable lazy image loading
- Minimize nested callouts
- Limit table complexity
- Use external images for large files

- Check for unclosed code blocks
- Verify proper syntax
- Look for special characters
- Try preview mode refresh

- Use correct WikiLink syntax [[]]
- Check file path is correct
- Verify file exists
- Update links after moving files

- Check image path
- Verify image in attachments folder
- Use correct image syntax
- Check file permissions