O

obsidian-markdown

Verified

by kepano · Updated Apr 16, 2026

opus
645in2.1Kout
$0.1957s

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.

obsidianmarkdownwikilinksfrontmatternotes

See It In Action

1 turns·claude
The project codebase is in your current working directory. Explore the files to understand the code before making changes. need the API outage retro note finished for this afternoon’s postmortem review in the vault

Let me explore the project structure to find any existing notes or vault content.

The retro note is a skeleton with TODOs. I have everything needed from the other vault notes to fill it in.

The retro note is complete. Here's what I filled in:

  • Frontmatter — title, date, tags (incident, postmortem, api), and alias
  • What Happened — summarized from the Incident Timeline: config deployment removed max_pool_size, causing DB connection exhaustion, 47-min outage, ~2,300 failed requests
  • Timeline — embedded via ![[Incident Timeline#Key Events]] so it stays in sync with the source note
  • Root Cause — connection pool exhaustion from missing config parameter, with a callout noting why it wasn't caught (no schema validation, no team review, low staging traffic)
  • Impact — duration, affected services, customer/revenue numbers
  • Action Items — 5 concrete items: CI schema validation, team approval gate, 80% capacity alert, runbook update, staging load testing
  • Related — wikilinks to [[Incident Timeline]], [[API Runbook]], and [[On-Call Rotation]]

Ready for the postmortem review.

Claude Sonnet 4.6

Permissions

ScopeDescription
filesystem:read
filesystem:write

SKILL.md

Obsidian Flavored Markdown Skill

Create 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.

Workflow: Creating an Obsidian Note

  1. Add frontmatter with properties (title, tags, aliases) at the top of the file. See PROPERTIES.md for all property types.
  2. Write content using standard Markdown for structure, plus Obsidian-specific syntax below.
  3. Link related notes using wikilinks ([[Note]]) for internal vault connections, or standard Markdown links for external URLs.
  4. Embed content from other notes, images, or PDFs using the ![[embed]] syntax. See EMBEDS.md for all embed types.
  5. Add callouts for highlighted information using > [!type] syntax. See CALLOUTS.md for all callout types.
  6. Verify the note renders correctly in Obsidian's reading view.

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.

Internal Links (Wikilinks)

[[Note Name]]                          Link to note
[[Note Name|Display Text]]             Custom display text
[[Note Name#Heading]]                  Link to heading
[[Note Name#^block-id]]                Link to block
[[#Heading in same note]]              Same-note heading link

Define a block ID by appending ^block-id to any paragraph:

This paragraph can be linked to. ^my-block-id

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

> A quote block

^quote-id

Embeds

Prefix any wikilink with ! to embed its content inline:

![[Note Name]]                         Embed full note
![[Note Name#Heading]]                 Embed section
![[image.png]]                         Embed image
![[image.png|300]]                     Embed image with width
![[document.pdf#page=3]]               Embed PDF page

See EMBEDS.md for audio, video, search embeds, and external images.

Callouts

> [!note]
> Basic callout.

> [!warning] Custom Title
> Callout with a custom title.

> [!faq]- Collapsed by default
> Foldable callout (- collapsed, + expanded).

Common types: note, tip, warning, info, example, quote, bug, danger, success, failure, question, abstract, todo.

See CALLOUTS.md for the full list with aliases, nesting, and custom CSS callouts.

Properties (Frontmatter)

---
title: My Note
date: 2024-01-15
tags:
  - project
  - active
aliases:
  - Alternative Name
cssclasses:
  - custom-class
---

Default properties: tags (searchable labels), aliases (alternative note names for link suggestions), cssclasses (CSS classes for styling).

See PROPERTIES.md for all property types, tag syntax rules, and advanced usage.

Tags

#tag                    Inline tag
#nested/tag             Nested tag with hierarchy

Tags can contain letters, numbers (not first character), underscores, hyphens, and forward slashes. Tags can also be defined in frontmatter under the tags property.

Comments

This is visible %%but this is hidden%% text.

%%
This entire block is hidden in reading view.
%%

Obsidian-Specific Formatting

==Highlighted text==                   Highlight syntax

Math (LaTeX)

Inline: $e^{i\pi} + 1 = 0$

Block:
$$
\frac{a}{b} = c
$$

Diagrams (Mermaid)

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Do this]
    B -->|No| D[Do that]
```

To link Mermaid nodes to Obsidian notes, add class NodeName internal-link;.

Footnotes

Text with a footnote[^1].

[^1]: Footnote content.

Inline footnote.^[This is inline.]

Complete Example

---
title: Project Alpha
date: 2024-01-15
tags:
  - project
  - active
status: in-progress
---

# Project Alpha

This project aims to [[improve workflow]] using modern techniques.

> [!important] Key Deadline
> The first milestone is due on ==January 30th==.

## Tasks

- [x] Initial planning
- [ ] Development phase
  - [ ] Backend implementation
  - [ ] Frontend design

## Notes

The algorithm uses $O(n \log n)$ sorting. See [[Algorithm Notes#Sorting]] for details.

![[Architecture Diagram.png|600]]

Reviewed in [[Meeting Notes 2024-01-10#Decisions]].

References

FAQ

What does obsidian-markdown do?

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.

When should I use obsidian-markdown?

Use it when you need a repeatable workflow that produces code diff.

What does obsidian-markdown output?

In the evaluated run it produced code diff.

How do I install or invoke obsidian-markdown?

Ask the agent to use this skill when the task matches its documented workflow.

Which agents does obsidian-markdown support?

Agent support is inferred from the source, but not explicitly declared.

What tools, channels, or permissions does obsidian-markdown need?

It uses no extra tools; channels commonly include diff; permissions include filesystem:read, filesystem:write.

Is obsidian-markdown safe to install?

Static analysis marked this skill as medium risk; review side effects and permissions before enabling it.

How is obsidian-markdown different from an MCP or plugin?

A skill packages instructions and workflow conventions; tools, MCP servers, and plugins are dependencies the skill may call during execution.

Does obsidian-markdown outperform not using a skill?

About obsidian-markdown

When to use obsidian-markdown

When editing .md files intended for an Obsidian vault. When the user wants wikilinks, callouts, embeds, or YAML properties added to notes. When converting plain Markdown notes into Obsidian-flavored Markdown.

When obsidian-markdown is not the right choice

When working with generic Markdown that does not need Obsidian-specific syntax. When the task requires interacting with the Obsidian app or external services rather than editing note files.

What it produces

Produces code diff.