Obsidian Markdown Extensions Reference

Obsidian Markdown Extensions Reference

Complete reference for Obsidian's markdown syntax beyond standard CommonMark.

Internal Links (Wikilinks)

Basic Links

[[Note Name]]                       # Link to note
[[Note Name|Display Text]]          # Link with alias
[[Folder/Note Name]]                # Link to note in folder
[[Note Name.md]]                    # Explicit extension

Heading Links

[[Note Name#Heading]]               # Link to heading
[[Note Name#Heading|text]]          # Heading link with alias
[[#Heading]]                        # Link to heading in current note

Block Links

[[Note Name#^block-id]]             # Link to specific block
[[Note Name#^block-id|text]]        # Block link with alias
[[#^block-id]]                      # Block in current note

Creating Block IDs

This is a paragraph that I want to reference. ^my-block-id

- List item ^list-block

> Quote block ^quote-block

Embeds (Transclusion)

Note Embeds

![[Note Name]]                      # Embed entire note
![[Note Name#Heading]]              # Embed section under heading
![[Note Name#^block-id]]            # Embed specific block

Image Embeds

![[image.png]]                      # Basic embed
![[image.png|100]]                  # Width in pixels
![[image.png|100x200]]              # Width x Height
![[image.png|alt text]]             # Alt text (with pipe)
![[Attachments/photo.jpg]]          # From subfolder

Other File Embeds

![[document.pdf]]                   # Embed PDF
![[document.pdf#page=5]]            # Embed PDF at page
![[audio.mp3]]                      # Embed audio player
![[video.mp4]]                      # Embed video player
![[file.csv]]                       # Embed CSV as table

External Embeds

![](https://example.com/image.png)  # External image
![|300](https://example.com/i.png)  # External with width

# YouTube (auto-detected)
![](https://www.youtube.com/watch?v=VIDEO_ID)
![](https://youtu.be/VIDEO_ID)

# Twitter/X
![](https://twitter.com/user/status/ID)

Callouts

Basic Syntax

> [!note]
> This is a note callout.

> [!info] Title Here
> Content with **formatting**.

> [!warning]
> Warning message.

Foldable Callouts

> [!tip]+ Expanded by Default
> This content is visible initially.

> [!example]- Collapsed by Default
> Click to expand this content.

Callout Types

Custom Callout Icons

Via CSS snippet:

.callout[data-callout="custom-type"] {
  --callout-color: 100, 150, 200;
  --callout-icon: lucide-sparkles;
}

Nested Callouts

> [!note] Outer
> Outer content
> > [!warning] Inner
> > Nested callout

Tags

Basic Tags

#tag                                # Simple tag
#nested/tag                         # Nested/hierarchical tag
#tag-with-dashes                    # Dashes allowed
#tag_with_underscores               # Underscores allowed
#123                                # Numeric tags allowed

Tag Restrictions

• Cannot contain spaces
• Cannot start with a number
• Case-insensitive matching
• Must follow word boundary

Inline vs Frontmatter Tags

---
tags:
  - tag1
  - tag2
  - nested/tag
---

This note has #inline-tag too.

Frontmatter (YAML)

Basic Frontmatter

---
title: My Note Title
date: 2024-01-15
author: Your Name
---

# Content starts here

Common Properties

---
# Standard properties
title: Note Title
date: 2024-01-15
created: 2024-01-01
modified: 2024-01-15

# Tags and categories
tags:
  - tag1
  - tag2
category: Category Name

# Aliases for linking
aliases:
  - Alternate Name
  - Another Alias

# Custom CSS class
cssclass: my-custom-class
cssclasses:
  - class1
  - class2

# Publishing
publish: true
permalink: custom-url

# Custom properties
status: draft
priority: high
rating: 5
---

Property Types

---
# String
title: "String Value"

# Number
count: 42
rating: 4.5

# Boolean
published: true
draft: false

# Date
date: 2024-01-15
datetime: 2024-01-15T10:30:00

# List
tags:
  - item1
  - item2

# Inline list
tags: [item1, item2, item3]

# Object/Map
metadata:
  key1: value1
  key2: value2

# Multi-line string
description: |
  This is a multi-line
  string value.
---

Comments

Inline Comments

This is visible. %%This is hidden.%%

More visible text.

Block Comments

%%
This entire block
is hidden from
the rendered view.
%%

Math (LaTeX)

Inline Math

The equation $E = mc^2$ is famous.

Inline: $\sum_{i=1}^{n} x_i$

Block Math

$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$

$$
\begin{aligned}
a &= b + c \\
d &= e + f
\end{aligned}
$$

Common LaTeX Symbols

Greek: $\alpha, \beta, \gamma, \delta$
Operators: $\sum, \prod, \int$
Relations: $\leq, \geq, \neq, \approx$
Arrows: $\to, \leftarrow, \Rightarrow$
Sets: $\in, \notin, \subset, \cup, \cap$

Code Blocks

Fenced Code

```javascript
const hello = "world";
console.log(hello);
```

Syntax Highlighting

Supported languages include:

• javascript, js
• typescript, ts
• python, py
• bash, shell, sh
• json, yaml
• css, html
• sql
• markdown, md
• And many more...

Line Numbers (Plugin)

Some themes/plugins support:

```javascript {1,3-5}
// Highlighted lines
const a = 1;
const b = 2;
const c = 3;
```

Diagrams (Mermaid)

Flowchart

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Action 1]
    B -->|No| D[Action 2]
    C --> E[End]
    D --> E
```

Sequence Diagram

```mermaid
sequenceDiagram
    participant A as Alice
    participant B as Bob
    A->>B: Hello Bob!
    B-->>A: Hi Alice!
```

Class Diagram

```mermaid
classDiagram
    Animal <|-- Duck
    Animal <|-- Fish
    Animal : +int age
    Animal : +String gender
    Animal: +isMammal()
```

Gantt Chart

```mermaid
gantt
    title Project Schedule
    dateFormat YYYY-MM-DD
    section Phase 1
    Task 1: 2024-01-01, 7d
    Task 2: 2024-01-08, 5d
```

State Diagram

```mermaid
stateDiagram-v2
    [*] --> Draft
    Draft --> Review
    Review --> Published
    Review --> Draft
    Published --> [*]
```

Tables

Basic Tables

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

Alignment

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

Extended Features

| With Links | With Formatting |
|------------|-----------------|
| [[Link]]   | **bold** text   |
| `code`     | *italic* text   |

Task Lists

Basic Tasks

- [ ] Uncompleted task
- [x] Completed task
- [ ] Another task

Nested Tasks

- [ ] Parent task
  - [ ] Subtask 1
  - [x] Subtask 2 (done)
  - [ ] Subtask 3

Custom Status (Plugins)

Some plugins support extended status:

- [ ] Todo
- [x] Done
- [/] In Progress
- [-] Cancelled
- [>] Forwarded
- [<] Scheduled
- [?] Question
- [!] Important

Footnotes

Inline Footnotes

Here is a statement[^1] with a footnote.

[^1]: This is the footnote content.

Multi-line Footnotes

Complex footnote[^note].

[^note]: This footnote has multiple paragraphs.

    Second paragraph of the footnote.

    Even code blocks work:
    ```
    code here
    ```

Highlights

==Highlighted text== using double equals.

Strikethrough

~~Strikethrough text~~

Horizontal Rules

---
***
___

External Links

Basic

[Link Text](https://example.com)
[Link with Title](https://example.com "Title")

Auto-linking

https://example.com          # Auto-linked
<https://example.com>        # Explicit auto-link
<email@example.com>          # Email link

Dataview (Plugin)

Inline Queries

`= this.file.name`
`= date(today)`
`= this.tags`

List Query

```dataview
LIST
FROM #tag
WHERE file.mtime > date(today) - dur(7 days)
SORT file.mtime DESC
```

Table Query

```dataview
TABLE file.ctime AS "Created", status
FROM "Projects"
WHERE status != "archived"
SORT file.ctime DESC
```

Task Query

```dataview
TASK
FROM "Daily Notes"
WHERE !completed
GROUP BY file.link
```

Templater (Plugin)

Basic Template

<%*
const title = await tp.system.prompt("Title?");
-%>
# <% title %>

Created: <% tp.date.now("YYYY-MM-DD") %>

Common Functions

<% tp.date.now("YYYY-MM-DD") %>
<% tp.file.title %>
<% tp.file.path() %>
<% tp.file.cursor() %>
<% tp.system.clipboard() %>

Query Blocks (Core)

Embed Search Results

```query
tag:#important
```

```query
path:Projects
```

Best Practices

Link Formatting

1. Use relative paths - Works across devices
2. Use aliases - Cleaner in preview
3. Avoid deep nesting - Hard to maintain

Frontmatter

1. Consistent property names - Case-sensitive
2. Quote strings with colons - YAML parsing
3. Use lists for multiple values - Better for queries

Organization

1. One topic per note - Atomic notes
2. Link liberally - Build knowledge graph
3. Use tags sparingly - Avoid over-categorization