obsidian-markdown

Create and edit Obsidian Flavored Markdown with wikilinks, embeds, and callouts.

Updated Jul 11, 2022
One-click install
npx skills add https://github.com/zhengfran/dotconfig --skill obsidian-markdown-zhengfran
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-markdown
Source: https://github.com/zhengfran/dotconfig/tree/main/tools/ai/agents/skills/obsidian-markdown
Command: npx skills add https://github.com/zhengfran/dotconfig --skill obsidian-markdown-zhengfran

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It solves the problem of writing Markdown that works correctly in Obsidian by providing a clear, Obsidian-specific syntax guide for wikilinks, embeds, callouts, properties, and other extensions.

Core Features & Use Cases

  • Wikilinks and block links: Link notes, headings, and specific blocks using [[Note]], [[Note#Heading]], and ^block-id.
  • Embeds and inline inclusion: Embed notes, headings, images, and PDF pages with ![[...]] syntax.
  • Callouts and frontmatter properties: Add rich callouts like > [!warning] and define note metadata using YAML frontmatter fields such as tags, aliases, and cssclasses.
  • Optional authoring helpers: Use Obsidian highlight syntax, math (LaTeX), Mermaid diagrams, tags, comments, and footnotes in a way Obsidian understands.

Quick Start

Create or update an Obsidian note using YAML frontmatter at the top and add wikilinks like [[Related Note]], callouts like > [!note] for emphasis, and embeds like ![[Some Note#Heading]] where you want inline content.

Frequently Asked Questions about obsidian-markdown

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write Obsidian markdown with wikilinks and block references?

Obsidian markdown uses [[Note]] for wikilinks, [[Note#Heading]] for heading links, and ^block-id for block references. Apply these syntax rules to ensure vault notes link correctly and render with Obsidian extensions.

What is the syntax for embedding notes and images in Obsidian?

Embedding in Obsidian requires the ![[...]] syntax. Use this format to embed entire notes, specific headings, images, or PDF pages directly inside your markdown files for inline content rendering.

How do I add YAML frontmatter properties to Obsidian notes?

YAML frontmatter properties in Obsidian notes are defined at the top of the markdown file. Add metadata fields like tags, aliases, and cssclasses to manage note properties and ensure Obsidian processes them correctly.

Can I create callouts and warnings using Obsidian flavored markdown?

Callouts in Obsidian flavored markdown use the > [!warning] or > [!note] syntax. Apply these specific extensions to add rich text callouts and emphasize important information within your daily notes.

Does Obsidian markdown support math, Mermaid diagrams, and footnotes?

Obsidian markdown supports LaTeX math, Mermaid diagrams, tags, comments, and footnotes. Use Obsidian's specific syntax rules for these authoring helpers to ensure the vault renders the content correctly.