Skip to content
Obsidian Flavored Markdown

Obsidian Flavored Markdown Skill

Teaches an agent to write valid Obsidian Flavored Markdown: wikilinks, block references, embeds, callouts, properties, tags, comments, highlights, math and Mermaid, from the obsidian-skills collection by Obsidian CEO Steph Ango.

GitHub Docs

Install

Install with the skills CLI

One command for Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf and dozens of other agents. Needs Node.js; the skill is fetched straight from obsidianmd/obsidian-skills.

$ npx skills add obsidianmd/obsidian-skills --skill obsidian-markdown

Run it in a terminal. The CLI finds the agents installed on your machine, asks which ones to add the skill to, and whether to install it into the folder you ran it from or for all your projects.

Other ways to install

Copy the whole skill folder — SKILL.md and any scripts or references beside it — into ~/.claude/skills/obsidian-markdown/, where Claude Code picks it up in every project. Only git is needed.

tmp=$(mktemp -d) && \
  git clone --depth 1 --branch main https://github.com/obsidianmd/obsidian-skills.git "$tmp" && \
  mkdir -p ~/.claude/skills && \
  cp -R "$tmp"/plugins/obsidian/skills/obsidian-markdown ~/.claude/skills/obsidian-markdown

No scripts or references next to it? Saving the SKILL.md alone as ~/.claude/skills/obsidian-markdown/SKILL.md works too.

Using another agent? Its personal skills folder
Codex
~/.agents/skills/
Cursor
~/.cursor/skills/
GitHub Copilot
~/.copilot/skills/
Gemini CLI
~/.gemini/skills/
Windsurf
~/.codeium/windsurf/skills/
OpenCode
~/.config/opencode/skills/

About

  • Wikilinks to notes, headings and block IDs, with display-text aliases
  • Embeds for notes, sections, images with width, and PDF pages
  • Callout syntax including foldable callouts and the common callout types
  • YAML properties (tags, aliases, cssclasses) and nested inline tags
  • Obsidian-only extras: %% comments %%, ==highlights==, LaTeX, Mermaid linking, footnotes

Obsidian Flavored Markdown is the most-installed skill in obsidian-skills, the collection published by Steph Ango (kepano), CEO of Obsidian. It gives a coding agent a precise reference for the syntax Obsidian adds on top of CommonMark and GitHub Flavored Markdown, so notes an agent writes into a vault link, embed and render the way Obsidian expects instead of as plain Markdown.

The skill assumes standard Markdown is already known and covers only Obsidian's extensions. Internal links use wikilinks, including links to headings and to block IDs defined with ^block-id, with the rule to use [[wikilinks]] inside the vault (Obsidian tracks renames) and ordinary Markdown links only for external URLs. Embeds prefix a wikilink with ! to pull in a whole note, a section, an image at a given width or a specific PDF page. Callouts use the > [!type] form, with - and + for collapsed or expanded foldable callouts.

It also documents frontmatter properties and the default tags, aliases and cssclasses keys, inline and nested tags and their character rules, hidden %% comments %%, ==highlights==, inline and block LaTeX, Mermaid diagrams (with class NodeName internal-link; to link nodes to notes) and footnotes. A six-step workflow for creating a note and a complete worked example tie it together, and reference files cover the full list of property types, embed types and callout types.

It is useful to anyone using Claude Code, Codex or another agent to write meeting notes, research or documentation into an Obsidian vault. MIT-licensed.

SKILL.md

The instructions your agent loads, as published by Steph Ango (kepano).

SKILL.md
name
obsidian-markdown
description
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 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](references/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](references/EMBEDS.md) for all embed types.
  5. Add callouts for highlighted information using > [!type] syntax. See [CALLOUTS.md](references/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.
[[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](references/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](references/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](references/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)

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
Install
New

Official Obsidian skill for creating and editing Bases (.base files): database-like table, cards, list, kanban and map views of notes with filters, formulas, summaries and sorting, plus YAML quoting rules and fixes for common errors.

Skill: Obsidian CLI

by Steph Ango (kepano)

New

Lets an agent drive a running Obsidian app through the official obsidian CLI: read, create, append to and search notes, manage tasks, properties and daily notes, and reload, debug and screenshot plugins and themes.

Integrate Firecrawl's /scrape endpoint into product code — turn a known URL into markdown, HTML, links, metadata or screenshots, with sensible defaults baked in.

Browse all skills →