1---
2name: obsidian-markdown
3description: 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.
4---
5 
6# Obsidian Flavored Markdown Skill
7 
8Create and edit valid Obsidian Flavored Markdown. Obsidian extends CommonMark and GFM with wikilinks, embeds, callouts, properties, comments, and other syntax. This skill covers only Obsidian-specific extensions -- standard Markdown (headings, bold, italic, lists, quotes, code blocks, tables) is assumed knowledge.
9 
10## Workflow: Creating an Obsidian Note
11 
121. **Add frontmatter** with properties (title, tags, aliases) at the top of the file. See [PROPERTIES.md](references/PROPERTIES.md) for all property types.
132. **Write content** using standard Markdown for structure, plus Obsidian-specific syntax below.
143. **Link related notes** using wikilinks (`[[Note]]`) for internal vault connections, or standard Markdown links for external URLs.
154. **Embed content** from other notes, images, or PDFs using the `![[embed]]` syntax. See [EMBEDS.md](references/EMBEDS.md) for all embed types.
165. **Add callouts** for highlighted information using `> [!type]` syntax. See [CALLOUTS.md](references/CALLOUTS.md) for all callout types.
176. **Verify** the note renders correctly in Obsidian's reading view.
18 
19> When choosing between wikilinks and Markdown links: use `[[wikilinks]]` for notes within the vault (Obsidian tracks renames automatically) and `[text](url)` for external URLs only.
20 
21## Internal Links (Wikilinks)
22 
23```markdown
24[[Note Name]]                          Link to note
25[[Note Name|Display Text]]             Custom display text
26[[Note Name#Heading]]                  Link to heading
27[[Note Name#^block-id]]                Link to block
28[[#Heading in same note]]              Same-note heading link
29```
30 
31Define a block ID by appending `^block-id` to any paragraph:
32 
33```markdown
34This paragraph can be linked to. ^my-block-id
35```
36 
37For lists and quotes, place the block ID on a separate line after the block:
38 
39```markdown
40> A quote block
41 
42^quote-id
43```
44 
45## Embeds
46 
47Prefix any wikilink with `!` to embed its content inline:
48 
49```markdown
50![[Note Name]]                         Embed full note
51![[Note Name#Heading]]                 Embed section
52![[image.png]]                         Embed image
53![[image.png|300]]                     Embed image with width
54![[document.pdf#page=3]]               Embed PDF page
55```
56 
57See [EMBEDS.md](references/EMBEDS.md) for audio, video, search embeds, and external images.
58 
59## Callouts
60 
61```markdown
62> [!note]
63> Basic callout.
64 
65> [!warning] Custom Title
66> Callout with a custom title.
67 
68> [!faq]- Collapsed by default
69> Foldable callout (- collapsed, + expanded).
70```
71 
72Common types: `note`, `tip`, `warning`, `info`, `example`, `quote`, `bug`, `danger`, `success`, `failure`, `question`, `abstract`, `todo`.
73 
74See [CALLOUTS.md](references/CALLOUTS.md) for the full list with aliases, nesting, and custom CSS callouts.
75 
76## Properties (Frontmatter)
77 
78```yaml
79---
80title: My Note
81date: 2024-01-15
82tags:
83  - project
84  - active
85aliases:
86  - Alternative Name
87cssclasses:
88  - custom-class
89---
90```
91 
92Default properties: `tags` (searchable labels), `aliases` (alternative note names for link suggestions), `cssclasses` (CSS classes for styling).
93 
94See [PROPERTIES.md](references/PROPERTIES.md) for all property types, tag syntax rules, and advanced usage.
95 
96## Tags
97 
98```markdown
99#tag                    Inline tag
100#nested/tag             Nested tag with hierarchy
101```
102 
103Tags can contain letters, numbers (not first character), underscores, hyphens, and forward slashes. Tags can also be defined in frontmatter under the `tags` property.
104 
105## Comments
106 
107```markdown
108This is visible %%but this is hidden%% text.
109 
110%%
111This entire block is hidden in reading view.
112%%
113```
114 
115## Obsidian-Specific Formatting
116 
117```markdown
118==Highlighted text==                   Highlight syntax
119```
120 
121## Math (LaTeX)
122 
123```markdown
124Inline: $e^{i\pi} + 1 = 0$
125 
126Block:
127$$
128\frac{a}{b} = c
129$$
130```
131 
132## Diagrams (Mermaid)
133 
134````markdown
135```mermaid
136graph TD
137    A[Start] --> B{Decision}
138    B -->|Yes| C[Do this]
139    B -->|No| D[Do that]
140```
141````
142 
143To link Mermaid nodes to Obsidian notes, add `class NodeName internal-link;`.
144 
145## Footnotes
146 
147```markdown
148Text with a footnote[^1].
149 
150[^1]: Footnote content.
151 
152Inline footnote.^[This is inline.]
153```
154 
155## Complete Example
156 
157````markdown
158---
159title: Project Alpha
160date: 2024-01-15
161tags:
162  - project
163  - active
164status: in-progress
165---
166 
167# Project Alpha
168 
169This project aims to [[improve workflow]] using modern techniques.
170 
171> [!important] Key Deadline
172> The first milestone is due on ==January 30th==.
173 
174## Tasks
175 
176- [x] Initial planning
177- [ ] Development phase
178  - [ ] Backend implementation
179  - [ ] Frontend design
180 
181## Notes
182 
183The algorithm uses $O(n \log n)$ sorting. See [[Algorithm Notes#Sorting]] for details.
184 
185![[Architecture Diagram.png|600]]
186 
187Reviewed in [[Meeting Notes 2024-01-10#Decisions]].
188````
189 
190## References
191 
192- [Obsidian Flavored Markdown](https://help.obsidian.md/obsidian-flavored-markdown)
193- [Internal links](https://help.obsidian.md/links)
194- [Embed files](https://help.obsidian.md/embeds)
195- [Callouts](https://help.obsidian.md/callouts)
196- [Properties](https://help.obsidian.md/properties)
197