Obsidian Markdown

Master Obsidian-flavored Markdown with wikilinks, callouts, and embeds

✨ The solution you've been looking for

Verified
Tested and verified by our team
16036 Stars

Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax. Use when working with .md files in Obsidian, or when the user mentions wikilinks, callouts, frontmatter, tags, embeds, or Obsidian notes.

obsidian markdown note-taking wikilinks knowledge-management documentation callouts frontmatter
Repository

See It In Action

Interactive preview & real-world examples

Live Demo
Skill Demo Animation

AI Conversation Simulator

See how users interact with this skill

User Prompt

Create an Obsidian note about machine learning with wikilinks to related concepts and embedded diagrams

Skill Processing

Analyzing request...

Agent Response

A properly formatted note with [[wikilinks]], ![[embeds]], and Obsidian-specific syntax that works seamlessly in your vault

Quick Start (3 Steps)

Get up and running in minutes

1

Install

claude-code skill install obsidian-markdown

claude-code skill install obsidian-markdown
2

Config

3

First Trigger

@obsidian-markdown help

Commands

CommandDescriptionRequired Args
@obsidian-markdown create-interconnected-notesBuild a network of linked notes with wikilinks, embeds, and cross-references for knowledge managementNone
@obsidian-markdown structure-information-with-calloutsOrganize content using Obsidian's callout system for tips, warnings, examples, and important informationNone
@obsidian-markdown set-up-note-properties-and-metadataCreate YAML frontmatter with tags, aliases, dates, and custom properties for better note organizationNone

Typical Use Cases

Create Interconnected Notes

Build a network of linked notes with wikilinks, embeds, and cross-references for knowledge management

Structure Information with Callouts

Organize content using Obsidian's callout system for tips, warnings, examples, and important information

Set Up Note Properties and Metadata

Create YAML frontmatter with tags, aliases, dates, and custom properties for better note organization

Overview

Obsidian Flavored Markdown Skill

This skill enables Claude Code to create and edit valid Obsidian Flavored Markdown, including all Obsidian-specific syntax extensions.

Overview

Obsidian uses a combination of Markdown flavors:

Basic Formatting

Paragraphs and Line Breaks

1This is a paragraph.
2
3This is another paragraph (blank line between creates separate paragraphs).
4
5For a line break within a paragraph, add two spaces at the end  
6or use Shift+Enter.

Headings

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

Text Formatting

StyleSyntaxExampleOutput
Bold**text** or __text__**Bold**Bold
Italic*text* or _text_*Italic*Italic
Bold + Italic***text******Both***Both
Strikethrough~~text~~~~Striked~~Striked
Highlight==text====Highlighted====Highlighted==
Inline code`code``code`code

Escaping Formatting

Use backslash to escape special characters:

1\*This won't be italic\*
2\#This won't be a heading
31\. This won't be a list item

Common characters to escape: \*, \_, \#, \`, \|, \~

1[[Note Name]]
2[[Note Name.md]]
3[[Note Name|Display Text]]
1[[Note Name#Heading]]
2[[Note Name#Heading|Custom Text]]
3[[#Heading in same note]]
4[[##Search all headings in vault]]
1[[Note Name#^block-id]]
2[[Note Name#^block-id|Custom Text]]

Define a block ID by adding ^block-id at the end of a paragraph:

1This is a paragraph that can be linked to. ^my-block-id

For lists and quotes, add the block ID on a separate line:

1> This is a quote
2> With multiple lines
3
4^quote-id
1[[##heading]]     Search for headings containing "heading"
2[[^^block]]       Search for blocks containing "block"
1[Display Text](Note%20Name.md)
2[Display Text](Note%20Name.md#Heading)
3[Display Text](https://example.com)
4[Note](obsidian://open?vault=VaultName&file=Note.md)

Note: Spaces must be URL-encoded as %20 in Markdown links.

Embeds

Embed Notes

1![[Note Name]]
2![[Note Name#Heading]]
3![[Note Name#^block-id]]

Embed Images

1![[image.png]]
2![[image.png|640x480]]    Width x Height
3![[image.png|300]]        Width only (maintains aspect ratio)

External Images

1![Alt text](https://example.com/image.png)
2![Alt text|300](https://example.com/image.png)

Embed Audio

1![[audio.mp3]]
2![[audio.ogg]]

Embed PDF

1![[document.pdf]]
2![[document.pdf#page=3]]
3![[document.pdf#height=400]]

Embed Lists

1![[Note#^list-id]]

Where the list has been defined with a block ID:

1- Item 1
2- Item 2
3- Item 3
4
5^list-id

Embed Search Results

1```query
2tag:#project status:done
3```

Callouts

Basic Callout

1> [!note]
2> This is a note callout.
3
4> [!info] Custom Title
5> This callout has a custom title.
6
7> [!tip] Title Only

Foldable Callouts

1> [!faq]- Collapsed by default
2> This content is hidden until expanded.
3
4> [!faq]+ Expanded by default
5> This content is visible but can be collapsed.

Nested Callouts

1> [!question] Outer callout
2> > [!note] Inner callout
3> > Nested content

Supported Callout Types

TypeAliasesDescription
note-Blue, pencil icon
abstractsummary, tldrTeal, clipboard icon
info-Blue, info icon
todo-Blue, checkbox icon
tiphint, importantCyan, flame icon
successcheck, doneGreen, checkmark icon
questionhelp, faqYellow, question mark
warningcaution, attentionOrange, warning icon
failurefail, missingRed, X icon
dangererrorRed, zap icon
bug-Red, bug icon
example-Purple, list icon
quoteciteGray, quote icon

Custom Callouts (CSS)

1.callout[data-callout="custom-type"] {
2  --callout-color: 255, 0, 0;
3  --callout-icon: lucide-alert-circle;
4}

Lists

Unordered Lists

1- Item 1
2- Item 2
3  - Nested item
4  - Another nested
5- Item 3
6
7* Also works with asterisks
8+ Or plus signs

Ordered Lists

11. First item
22. Second item
3   1. Nested numbered
4   2. Another nested
53. Third item
6
71) Alternative syntax
82) With parentheses

Task Lists

1- [ ] Incomplete task
2- [x] Completed task
3- [ ] Task with sub-tasks
4  - [ ] Subtask 1
5  - [x] Subtask 2

Quotes

1> This is a blockquote.
2> It can span multiple lines.
3>
4> And include multiple paragraphs.
5>
6> > Nested quotes work too.

Code

Inline Code

1Use `backticks` for inline code.
2Use double backticks for ``code with a ` backtick inside``.

Code Blocks

 1```
 2Plain code block
 3```
 4
 5```javascript
 6// Syntax highlighted code block
 7function hello() {
 8  console.log("Hello, world!");
 9}
10```
11
12```python
13# Python example
14def greet(name):
15    print(f"Hello, {name}!")
16```

Nesting Code Blocks

Use more backticks or tildes for the outer block:

1````markdown
2Here's how to create a code block:
3```js
4console.log("Hello")
5```
6````

Tables

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

Alignment

1| Left     | Center   | Right    |
2|:---------|:--------:|---------:|
3| Left     | Center   | Right    |

Using Pipes in Tables

Escape pipes with backslash:

1| Column 1 | Column 2 |
2|----------|----------|
3| [[Link\|Display]] | ![[Image\|100]] |

Math (LaTeX)

Inline Math

1This is inline math: $e^{i\pi} + 1 = 0$

Block Math

1$$
2\begin{vmatrix}
3a & b \\
4c & d
5\end{vmatrix} = ad - bc
6$$

Common Math Syntax

1$x^2$              Superscript
2$x_i$              Subscript
3$\frac{a}{b}$      Fraction
4$\sqrt{x}$         Square root
5$\sum_{i=1}^{n}$   Summation
6$\int_a^b$         Integral
7$\alpha, \beta$    Greek letters

Diagrams (Mermaid)

1```mermaid
2graph TD
3    A[Start] --> B{Decision}
4    B -->|Yes| C[Do this]
5    B -->|No| D[Do that]
6    C --> E[End]
7    D --> E
8```

Sequence Diagrams

1```mermaid
2sequenceDiagram
3    Alice->>Bob: Hello Bob
4    Bob-->>Alice: Hi Alice
5```

Linking in Diagrams

1```mermaid
2graph TD
3    A[Biology]
4    B[Chemistry]
5    A --> B
6    class A,B internal-link;
7```

Footnotes

1This sentence has a footnote[^1].
2
3[^1]: This is the footnote content.
4
5You can also use named footnotes[^note].
6
7[^note]: Named footnotes still appear as numbers.
8
9Inline footnotes are also supported.^[This is an inline footnote.]

Comments

1This is visible %%but this is hidden%% text.
2
3%%
4This entire block is hidden.
5It won't appear in reading view.
6%%

Horizontal Rules

1---
2***
3___
4- - -
5* * *

Properties (Frontmatter)

Properties use YAML frontmatter at the start of a note:

 1---
 2title: My Note Title
 3date: 2024-01-15
 4tags:
 5  - project
 6  - important
 7aliases:
 8  - My Note
 9  - Alternative Name
10cssclasses:
11  - custom-class
12status: in-progress
13rating: 4.5
14completed: false
15due: 2024-02-01T14:30:00
16---

Property Types

TypeExample
Texttitle: My Title
Numberrating: 4.5
Checkboxcompleted: true
Datedate: 2024-01-15
Date & Timedue: 2024-01-15T14:30:00
Listtags: [one, two] or YAML list
Linksrelated: "[[Other Note]]"

Default Properties

  • tags - Note tags
  • aliases - Alternative names for the note
  • cssclasses - CSS classes applied to the note

Tags

 1#tag
 2#nested/tag
 3#tag-with-dashes
 4#tag_with_underscores
 5
 6In frontmatter:
 7---
 8tags:
 9  - tag1
10  - nested/tag2
11---

Tags can contain:

  • Letters (any language)
  • Numbers (not as first character)
  • Underscores _
  • Hyphens -
  • Forward slashes / (for nesting)

HTML Content

Obsidian supports HTML within Markdown:

 1<div class="custom-container">
 2  <span style="color: red;">Colored text</span>
 3</div>
 4
 5<details>
 6  <summary>Click to expand</summary>
 7  Hidden content here.
 8</details>
 9
10<kbd>Ctrl</kbd> + <kbd>C</kbd>

Complete Example

 1---
 2title: Project Alpha
 3date: 2024-01-15
 4tags:
 5  - project
 6  - active
 7status: in-progress
 8priority: high
 9---
10
11# Project Alpha
12
13## Overview
14
15This project aims to [[improve workflow]] using modern techniques.
16
17> [!important] Key Deadline
18> The first milestone is due on ==January 30th==.
19
20## Tasks
21
22- [x] Initial planning
23- [x] Resource allocation
24- [ ] Development phase
25  - [ ] Backend implementation
26  - [ ] Frontend design
27- [ ] Testing
28- [ ] Deployment
29
30## Technical Notes
31
32The main algorithm uses the formula $O(n \log n)$ for sorting.
33
34```python
35def process_data(items):
36    return sorted(items, key=lambda x: x.priority)
37```
38
39## Architecture
40
41```mermaid
42graph LR
43    A[Input] --> B[Process]
44    B --> C[Output]
45    B --> D[Cache]
46```
47
48## Related Documents
49
50- ![[Meeting Notes 2024-01-10#Decisions]]
51- [[Budget Allocation|Budget]]
52- [[Team Members]]
53
54## References
55
56For more details, see the official documentation[^1].
57
58[^1]: https://example.com/docs
59
60%%
61Internal notes:
62- Review with team on Friday
63- Consider alternative approaches
64%%

References

What Users Are Saying

Real feedback from the community

Environment Matrix

Dependencies

Obsidian app (any version)

Framework Support

CommonMark ✓ GitHub Flavored Markdown ✓ LaTeX math ✓ Mermaid diagrams ✓

Context Window

Token Usage Varies based on document complexity, typically 1K-10K tokens

Security & Privacy

Information

Author
davila7
Updated
2026-01-30
Category
productivity-tools