Skill

Generate Obsidian Flavored Markdown

Covers Obsidian's Markdown extensions: wikilinks, embeds, callouts, frontmatter properties, tags, and Mermaid diagrams.

Works with obsidian

91
Spark score
out of 100
Updated 20 days ago
Version 14.1.0

Add to Favorites

Why it matters

Create and edit Markdown notes specifically for Obsidian, leveraging its unique features like wikilinks, embeds, callouts, and properties to ensure seamless rendering within the Obsidian environment.

Outcomes

What it gets done

01

Generate notes with Obsidian-specific syntax

02

Incorporate wikilinks for internal note connections

03

Add callouts and embeds for enhanced content

04

Format frontmatter properties and tags correctly

Install

Add it to your toolbox

Run in your project directory:

curl -fsSL https://spark.entire.vc/get/ag-obsidian-markdown | bash

Overview

Obsidian Flavored Markdown Skill

A syntax reference for Obsidian's Markdown extensions - wikilinks, embeds, typed callouts, YAML frontmatter properties, tags, comments, highlights, math, and Mermaid diagrams. Use when writing or editing notes meant for an Obsidian vault and needing correct Obsidian-specific Markdown syntax rather than plain CommonMark.

What it does

Obsidian Flavored Markdown Skill creates and edits valid Obsidian Flavored Markdown - Obsidian's extensions on top of CommonMark and GFM, covering wikilinks, embeds, callouts, frontmatter properties, comments, and other Obsidian-specific syntax. It assumes standard Markdown (headings, bold, italic, lists, quotes, code blocks, tables) as known and covers only the Obsidian-specific extensions.

When to use - and when NOT to

Use this when writing or editing Markdown notes intended for Obsidian, when the task involves wikilinks, embeds, callouts, frontmatter properties, or other Obsidian-specific syntax, or when notes need to render correctly inside an Obsidian vault.

Inputs and outputs

The note-creation workflow: add frontmatter properties (title, tags, aliases) at the top of the file; write content in standard Markdown plus Obsidian syntax; link related notes with wikilinks [[Note]], which Obsidian tracks through renames automatically, reserving plain Markdown links for external URLs; embed content from other notes, images, or PDFs by prefixing a wikilink with !, e.g. ![[Note Name#Heading]] for a section or ![[document.pdf#page=3]] for a PDF page; add callouts for highlighted information with > [!type] syntax, where common types include note, tip, warning, info, example, quote, bug, danger, success, failure, question, abstract, and todo, with -/+ for collapsed or expanded; and verify the note renders correctly in reading view. Wikilinks also support custom display text ([[Note|Text]]), heading links ([[Note#Heading]]), and block links via a ^block-id appended to a paragraph or placed on its own line after a list or quote.

Integrations

Frontmatter properties are written as YAML, with tags, aliases, and cssclasses available by default; inline tags use #tag or nested #tag/subtag syntax and can also live in the tags property. Additional syntax covers hidden comments (%%hidden%%), ==highlighted text==, inline and block LaTeX math ($e^{i\pi}+1=0$, $$...$$), Mermaid diagrams in fenced code blocks, with class NodeName internal-link; to link a diagram node to an Obsidian note, and footnotes ([^1] plus a matching definition, or an inline ^[...] footnote). Deeper detail for each area lives in companion reference files: PROPERTIES.md, EMBEDS.md, and CALLOUTS.md.

Who it's for

Anyone writing or editing notes for an Obsidian vault who needs correct syntax for internal linking, embedding, callouts, structured frontmatter, and Obsidian-only extensions like highlights, Mermaid diagrams, and footnotes, built on top of assumed standard-Markdown knowledge. A worked example ties these together: a project note with YAML frontmatter (title, date, tags, a custom status field), a wikilink to a related note, an [!important] callout with a highlighted deadline, a nested markdown task list, inline LaTeX, an embedded image sized with |600, and a link into a specific heading of a meeting-notes file.

FAQ

Common questions

Discussion

Questions & comments · 0

Sign In Sign in to leave a comment.