Agent skill

Obsidian Markdown Syntax

by AgriciDaniel in AgriciDaniel/claude-obsidian

Explains, drafts and validates Obsidian Flavored Markdown such as properties, wikilinks, embeds, callouts and Mermaid, with vault edits applied through approved transactions.

MITAuto-check passedKnowledge Management

Install Obsidian Markdown Syntax

skills CLI
$ npx skills add AgriciDaniel/claude-obsidian --skill obsidian-markdown -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install AgriciDaniel/claude-obsidian obsidian-markdown --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/AgriciDaniel/claude-obsidian.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/obsidian-markdown .claude/skills/obsidian-markdown && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
obsidian-markdown
GitHub stars
15k
Token cost
~1.1k tokens
SKILL.md length
383 words
Files
1
Skills in repo
15
Repo updated
First seen
Licence
MIT

At a glance

Explains, drafts and validates Obsidian Flavored Markdown such as properties, wikilinks, embeds, callouts and Mermaid, with vault edits applied through approved transactions.

  • Checking how Obsidian callouts, embeds or block references are written
  • SKILL.md covers Properties, Wikilinks and embeds, Callouts and Other Obsidian syntax, plus 1 more section
  • Calls python3
  • Drafting a note with correct properties and wikilinks

What it does

This skill explains, drafts and validates Obsidian Flavored Markdown: properties, wikilinks, embeds, callouts, tags, comments, highlights, block references, math and Mermaid. It is a compact fallback, and the agent prefers a separately installed obsidian-markdown skill or the current Obsidian Help for detailed or version-sensitive questions. It is for explicit Obsidian formatting requests, not general Markdown or broad vault operations.

Syntax questions are answered read-only. A vault edit is drafted as a complete note and applied through a transaction bundle handled by the claude-obsidian.py core script: it is inspected first and applied only with an approval hash after review, and a note is never written directly. Guidance covers flat YAML properties with ISO dates and quoted wikilinks, block lists rather than inline arrays, quoted numeric tags, wikilink forms, and callouts that start collapsed or expanded. Creating or removing a page also updates an index or map of content.

When your agent uses it

  • Checking how Obsidian callouts, embeds or block references are written
  • Drafting a note with correct properties and wikilinks
  • Validating Obsidian-specific syntax in an existing note
  • Preparing a vault edit as a reviewed transaction bundle

Example prompts

  • “Show me the Obsidian syntax for a collapsed callout.”
  • “Draft a concept note with flat YAML properties and wikilinks to two related notes.”
  • “Check this note for Obsidian syntax mistakes in its embeds and tags.”

Requirements

  • The claude-obsidian plugin core script for vault edits
  • Python 3 to run that script

What it can do on your machine

Read from SKILL.md and the folder at commit 32ac5a0. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • python3

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • help.obsidian.md

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Obsidian Markdown Syntax loads about 1.1k tokens when it runs. Until then it costs about 79 tokens; SKILL.md has 383 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~79
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from AgriciDaniel/claude-obsidian at commit 32ac5a0, republished under its MIT licence (© AgriciDaniel). 383 words, ~1,124 tokens.

Download SKILL.mdSave it as .claude/skills/obsidian-markdown/SKILL.md (or your agent's skills folder).
name
obsidian-markdown
description
Explain, draft, or validate Obsidian Flavored Markdown syntax: properties, wikilinks, embeds, callouts, tags, comments, highlights, block references, math, and Mermaid. Use when the user explicitly requests Obsidian note formatting or syntax help, not for general Markdown or broad vault operations.

Obsidian Flavored Markdown

Use this as a compact fallback for Obsidian-specific syntax. Prefer a separately installed kepano/obsidian-skills obsidian-markdown skill when available, then current Obsidian Help, for detailed or version-sensitive questions.

Resolve the installed product root from this skill's own location, not from the vault or current working directory:

bash
PRODUCT_ROOT=/absolute/path/to/installed/claude-obsidian
CORE="$PRODUCT_ROOT/scripts/claude-obsidian.py"
test -f "$CORE"

Every ../wiki/references/ link in this file resolves the same way, relative to this skill's own directory under $PRODUCT_ROOT, never relative to the selected vault's wiki/ directory.

Answer syntax questions read-only. If the user requests a vault edit, draft the complete note, read operation-transactions.md, and build one claude-obsidian.transaction.v1 bundle with operation_type: markdown and only wiki/ targets. Inspect it, then set APPROVAL_SHA256 to the returned approval_sha256 after review and apply it through the same vault-bound plan. A canonical page create or removal includes an active index or MOC update in that bundle; update the overview only when its stable high-level synthesis changed:

bash
python3 "$CORE" transaction inspect "$BUNDLE" --vault "$VAULT"
python3 "$CORE" transaction apply "$BUNDLE" --vault "$VAULT" \
  --approved-plan-sha256 "$APPROVAL_SHA256"

Never write a note directly.

Properties

Use flat YAML properties and YYYY-MM-DD dates. Quote wikilinks inside YAML.

yaml
---
type: concept
title: "Contextual Retrieval"
created: 2026-07-11
updated: 2026-07-11
status: developing
tags:
  - retrieval
  - ai/knowledge
aliases:
  - Context-aware retrieval
related:
  - "[[Retrieval]]"
sources:
  - "[[Anthropic Contextual Retrieval]]"
---

Do not nest objects in generated wiki properties. Use block lists rather than inline YAML arrays. Quote numeric-only tag values, for example - "2026", so YAML parsers preserve them as tags instead of numbers. Keep unknown existing properties unless the requested edit changes them.

markdown
[[Note Name]]
[[Note Name|Display text]]
[[Note Name#Heading]]
[[Note Name#^block-id]]
[[Folder/Note Name]]

This paragraph is addressable. ^evidence-block

![[Note Name#Summary]]
![[diagram.png|480]]
![[paper.pdf#page=3]]

Match the target filename exactly. Use a vault-relative folder path when a basename is ambiguous. Use standard Markdown links for external URLs; use wikilinks for this vault's notes.

Show full SKILL.md (144 more words)Show less

Callouts

markdown
> [!note]
> Supporting context.

> [!warning] Review required
> This claim has contradictory evidence.

> [!question]- Open question
> What evidence would resolve this?

- starts collapsed and + starts expanded. Common built-in types include note, abstract, info, todo, tip, success, question, warning, failure, danger, bug, example, and quote. Preserve custom vault callout types rather than rewriting them.

Other Obsidian syntax

markdown
#inline-tag #nested/tag

==Highlighted text==

Visible text %%hidden comment%%

Inline math: $E = mc^2$

$$
\int_0^1 x^2\,dx = \frac{1}{3}
$$

```mermaid
flowchart LR
  Source --> Claim
```

Standard CommonMark/GFM headings, lists, tasks, tables, code fences, and footnotes remain valid. Avoid HTML when native Markdown is sufficient.

Validate a drafted note

  • Parse the YAML boundary and keep property types consistent.
  • Verify every internal target, heading, and block reference that can be checked locally; never fabricate a target to make a link look complete.
  • Keep evidence wording distinct from inference and preserve source locators.
  • Ensure code fences and callout quoting are balanced.
  • Run deterministic wiki lint after a requested mutation and report remaining findings without silently repairing them.

For source-cited pages, also follow provenance.md. Report the transaction operation ID and exact changed paths after an applied edit.

© AgriciDaniel, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/obsidian-markdown of AgriciDaniel/claude-obsidian.

Open the folder on GitHubat commit 32ac5a0

Compare with similar skills

Obsidian Markdown Syntax next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Obsidian Markdown Syntax compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Obsidian Markdown Syntax this skillAgriciDaniel/claude-obsidian15k—~1.1kAutomated safety check: PassMIT
Luhmann Note Numberertwhsi/skills259—~1.5kAutomated safety check: PassNone
Obsidian Vaultravila4/claude-adhd-skills157—~2.3kAutomated safety check: PassMIT
Knap Markdown Templateskepano/obsidian-skills49k2 repos~986Automated safety check: PassMIT
Obsidian MarkdownKevRojo/Dulus153—~1.4kAutomated safety check: PassGPL-3.0
EPUB to HyperCard Obsidiantwhsi/skills259—~1kAutomated safety check: PassNone

Similar skills

  • Assigns and checks Luhmann-style codes for book manuscript notes and Obsidian card folders without renumbering existing notes.

    259 GitHub stars~1.5k tokensUpdated 2 mo ago
    Knowledge ManagementAuto-check passed
  • Obsidian Vault

    ravila4/claude-adhd-skills

    Manage Obsidian vault operations. An agent skill from ravila4/claude-adhd-skills.

    157 GitHub stars~2.3k tokensUpdated 7 mo ago
    Knowledge ManagementAuto-check passed
  • Knap Markdown Templates

    kepano/obsidian-skills

    Renders Markdown notes from Knap templates and JSON data on the command line, including notes built from Defuddle web page output.

    49k GitHub starsUsed in 2 repos~986 tokens
    Documents & OfficeAuto-check passed
  • Obsidian Markdown

    KevRojo/Dulus

    Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax.

    153 GitHub stars~1.4k tokensUpdated 7 days ago
    Documents & OfficeAuto-check passed
  • Converts an EPUB card book into an Obsidian folder with one Markdown file per card, keyword cards, navigation links and an optional shareable zip.

    259 GitHub stars~1k tokensUpdated 2 mo ago
    Documents & OfficeAuto-check passed
  • Obsidian Markdown

    Atmosphere/atmosphere

    Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax.

    3.8k GitHub starsUsed in 20 repos~1.3k tokens
    Documents & OfficeAuto-check passed

More from AgriciDaniel/claude-obsidian

All 15 skills in this repo
  • Bounded Autoresearch

    AgriciDaniel/claude-obsidian

    Runs a bounded, source-grounded research loop that drafts a cited dossier and can propose a separately reviewed merge into an Obsidian vault.

    15k GitHub stars~1.6k tokensUpdated 29 days ago
    Auto-check passed
  • Obsidian Canvas Boards

    AgriciDaniel/claude-obsidian

    Creates, inspects and updates Obsidian JSON Canvas boards in a vault, with text, file, link, group and edge nodes, using safe recoverable edits.

    15k GitHub stars~1.4k tokensUpdated 29 days ago
    Auto-check passed
  • Obsidian Wiki Vault Setup

    AgriciDaniel/claude-obsidian

    Sets up or adopts a separate Obsidian knowledge vault through the claude-obsidian core script and routes follow-up work to the right wiki sub-skill.

    15k GitHub stars~1.3k tokensUpdated 29 days ago
    Auto-check passed
  • Obsidian Wiki Log Fold

    AgriciDaniel/claude-obsidian

    Creates a bounded, extractive rollup of recent Obsidian wiki log entries, previewed by default, with one optional apply step and no changes to child pages.

    15k GitHub stars~1.2k tokensUpdated 29 days ago
    Auto-check passed
  • Defuddle Web Page Cleaner

    AgriciDaniel/claude-obsidian

    Plans, and with explicit network consent runs, an external Defuddle extractor that turns an article-like HTTPS page into clean Markdown for later wiki ingestion.

    15k GitHub stars~1.1k tokensUpdated 29 days ago
    Auto-check passed
  • Obsidian Bases Editor

    AgriciDaniel/claude-obsidian

    Explains, drafts and validates Obsidian Bases .base files, building filters, formulas and table, card or list views, and applying edits only through one inspected transaction.

    15k GitHub stars~1.2k tokensUpdated 29 days ago
    Auto-check passed

Works with

Questions about Obsidian Markdown Syntax

What does Obsidian Markdown Syntax do?

Explains, drafts and validates Obsidian Flavored Markdown such as properties, wikilinks, embeds, callouts and Mermaid, with vault edits applied through approved transactions. This skill explains, drafts and validates Obsidian Flavored Markdown: properties, wikilinks, embeds, callouts, tags, comments, highlights, block references, math and Mermaid. It is a compact fallback, and the agent prefers a separately installed obsidian-markdown skill or the current Obsidian Help for detailed or version-sensitive questions.

When should I use Obsidian Markdown Syntax?

Obsidian Markdown Syntax fits situations like: checking how Obsidian callouts, embeds or block references are written; drafting a note with correct properties and wikilinks; validating Obsidian-specific syntax in an existing note; preparing a vault edit as a reviewed transaction bundle.

How do I install Obsidian Markdown Syntax in Claude Code?

Run `npx skills add AgriciDaniel/claude-obsidian --skill obsidian-markdown -a claude-code`. Or copy the skill folder (skills/obsidian-markdown in AgriciDaniel/claude-obsidian) into .claude/skills/obsidian-markdown in your project. Claude Code loads it when a task matches its description.

How do I install Obsidian Markdown Syntax in Codex?

Run `npx skills add AgriciDaniel/claude-obsidian --skill obsidian-markdown -a codex`. Or copy the skill folder (skills/obsidian-markdown in AgriciDaniel/claude-obsidian) into .agents/skills/obsidian-markdown in your project. Codex loads it when a task matches its description.

Can I use Obsidian Markdown Syntax in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add AgriciDaniel/claude-obsidian --skill obsidian-markdown -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/obsidian-markdown, .gemini/skills/obsidian-markdown, .github/skills/obsidian-markdown and .opencode/skills/obsidian-markdown in your project.

What does Obsidian Markdown Syntax need to run?

Going by SKILL.md and its folder, Obsidian Markdown Syntax needs the command-line tools its instructions call (python3). Our summary lists: The claude-obsidian plugin core script for vault edits; Python 3 to run that script.

Does Obsidian Markdown Syntax access the network?

SKILL.md names 1 domain. As links in the text: help.obsidian.md. This is read from the text; nothing was executed.

Is Obsidian Markdown Syntax safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Obsidian Markdown Syntax use?

Obsidian Markdown Syntax is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Obsidian Markdown Syntax use?

About 1.1k tokens (SKILL.md is roughly 4.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Obsidian Markdown Syntax?

Skills that share tags, products or a category with Obsidian Markdown Syntax: Luhmann Note Numberer (twhsi/skills, 259 stars), Obsidian Vault (ravila4/claude-adhd-skills, 157 stars), Knap Markdown Templates (kepano/obsidian-skills, 49k stars) and Obsidian Markdown (KevRojo/Dulus, 153 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Obsidian Markdown Syntax?

AgriciDaniel (a GitHub user) maintains it in AgriciDaniel/claude-obsidian, which has 15,420 GitHub stars. The repository holds 15 skills in this directory. The repository was last updated on September 10, 2026.

Source: AgriciDaniel/claude-obsidian on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.