agentleFS
manazoid4manazoid4/maz-works-knowledge-vault/skills/obsidian-markdown/SKILL.md

obsidian-markdown

Skill0 starsChanged 3 months agoMITView on GitHub

Write correct Obsidian Flavored Markdown: wikilinks, embeds, callouts, properties, tags, highlights, math, and canvas syntax. Reference this when creating or editing any wiki page. Triggers on: write obsidian note, obsidian syntax, wikilink, callout, embed, obsidian markdown, wikilink format, callout syntax, embed syntax, obsidian formatting, how to write obsidian markdown.

86 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use knap, obsidian-cli and 4 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • lucasmaher-hashSkill

    knap

    Render Markdown from templates and structured data using Knap CLI. Use when the user asks to apply a Knap template, turn JSON or CSV data into notes, batch-generate Markdown files, or format Defuddle output into a note.

    Also in 4 projects that use this

  • jykimSkill

    obsidian-cli

    Interact with Obsidian using the official CLI to read, search, create, and manage notes, daily notes, tasks, properties, and more. Use when the user wants to query or manipulate vault content via the obsidian command.

    Also in 38 projects that use this

  • BCS1037Skill

    mermaid-visualizer

    Transform text content into professional Mermaid diagrams for presentations and documentation. Use when users ask to visualize concepts, create flowcharts, or make diagrams from text. Supports process flows, system architectures, comparisons, mindmaps, and more with built-in syntax error prevention.

    Also in 4 projects that use this

  • 0xHoneyJarSkill

    qmd

    Local markdown search engine for knowledge bases, notes, and documentation. Combines BM25 full-text search, vector semantic search, and LLM re-ranking. Use when searching through markdown notes, retrieving documents, or managing knowledge collections.

    Also in 3 projects that use this

  • MicrosoftSkill

    excalidraw-diagram

    Create Excalidraw diagram JSON files that make visual arguments. Use when the user wants to visualize workflows, architectures, or concepts.

    Also in 4 projects that use this

  • RoundTable02Skill

    tutor

    Interactive quiz tutor for Obsidian StudyVault learning. Use when the user wants to: (1) Take a diagnostic assessment of their knowledge, (2) Study or review specific sections/topics, (3) Drill weak areas identified in previous sessions, (4) Check their learning progress or dashboard, or says things like "quiz me", "test me", "let's study", "/tutor", "학습", "퀴즈", "평가".

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

9 rules. 0 are common, 2 are distinctive, and 7 are very specific to this project.

  • 0

    Common

    Most of the 81 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No path needed: Obsidian resolves by filename uniqueness.

    line 28
  2. Very specific:

    If two files have the same name, use [[Folder/Note Name]] to disambiguate.

    line 29
  3. Very specific:

    Do not use # inside frontmatter tag lists.

    line 133
  4. Very specific:

    Do not use link text for internal links: use [[Note Name]] instead.

    line 227
  5. Distinctive:

    Do not use HTML inside callouts: stick to Markdown.

    line 228
  6. Very specific:

    Do not use ## inside a callout body: headings don't render inside callouts.

    line 229
  7. Very specific:

    Do not write tags: [a, b, c] inline in frontmatter: Obsidian prefers the list format.

    line 230
  8. Very specific:

    Do not write ISO datetimes in frontmatter (2026-04-08T00:00:00Z): use 2026-04-08.

    line 231
  9. Very specific:

    When working on this skill, apply the 10-principle loop.

    line 237

“Common” is measured: kept by at least 6 in 10 of the 81 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

obsidian-markdown: Obsidian Flavored Markdown

Reference this skill when writing any wiki page. Obsidian extends standard Markdown with wikilinks, embeds, callouts, and properties. Getting syntax wrong causes broken links, invisible callouts, or malformed frontmatter.

Substrate preference (v1.7+): This skill is a self-contained fallback. Prefer kepano/obsidian-skills (by Steph Ango, Obsidian CEO) as the authoritative substrate — its obsidian-markdown skill is the canonical Obsidian syntax reference for any Agent Skills runtime. If that separate skill is available, use it. The reference below keeps Maz Works Knowledge Vault functional when kepano's marketplace is not installed. Install: claude plugin marketplace add kepano/obsidian-skills. Repo: github.com/kepano/obsidian-skills.


Wikilinks

Internal links use double brackets. The filename without extension.

SyntaxWhat it does
[[Note Name]]Basic link
[[Note Name|Display Text]]Aliased link (shows "Display Text")
[[Note Name#Heading]]Link to a specific heading
[[Note Name#^block-id]]Link to a specific block

Rules:

  • Case-sensitive on some systems. Match the exact filename.
  • No path needed: Obsidian resolves by filename uniqueness.
  • If two files have the same name, use [[Folder/Note Name]] to disambiguate.

Embeds

Embeds use ! before the wikilink. They display the content inline.

SyntaxWhat it does
![[Note Name]]Embed a full note
![[Note Name#Heading]]Embed a section
![[image.png]]Embed an image
![[image.png|300]]Embed image with width 300px
![[document.pdf]]Embed a PDF (Obsidian renders natively)
![[audio.mp3]]Embed audio

Callouts

Callouts are blockquotes with a type keyword. They render as styled alert boxes.

> [!note]
> Default informational callout.

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

> [!note]- Collapsible (closed by default)
> Click to expand.

> [!note]+ Collapsible (open by default)
> Click to collapse.

All callout types

TypeAliasesUse for
note:General notes
abstractsummary, tldrSummaries
info:Information
todo:Action items
tiphint, importantTips and highlights
successcheck, donePositive outcomes
questionhelp, faqOpen questions
warningcaution, attentionWarnings
failurefail, missingErrors or failures
dangererrorCritical issues
bug:Known bugs
example:Examples
quoteciteQuotations
contradiction:Conflicting information (wiki convention)

Properties (Frontmatter)

Obsidian renders YAML frontmatter as a Properties panel. Rules:

---
type: concept                    # plain string
title: "Note Title"              # quoted if it contains special chars
created: 2026-04-08              # date as YYYY-MM-DD (not ISO datetime)
updated: 2026-04-08
tags:
  - tag-one                      # list items use - format
  - tag-two
status: developing
related:
  - "[[Other Note]]"             # wikilinks must be quoted in YAML
sources:
  - "[[source-page]]"
---

Rules:

  • Flat YAML only. Never nest objects.
  • Dates as YYYY-MM-DD, not 2026-04-08T00:00:00.
  • Lists as - item, not inline [a, b, c].
  • Wikilinks in YAML must be quoted: "[[Page]]".
  • tags field: Obsidian reads this as the tag list, searchable in vault.

Tags

Two valid forms:

#tag-name             : inline tag anywhere in the body
#parent/child-tag     : nested tag (shows hierarchy in tag pane)

In frontmatter:

tags:
  - research
  - ai/obsidian

Do not use # inside frontmatter tag lists. Just the tag name.


Text Formatting

Standard Markdown plus Obsidian extensions:

SyntaxResult
**bold**Bold
*italic*Italic
~~strikethrough~~Strikethrough
==highlight==Highlighted text (yellow in Obsidian)
`inline code`Inline code

Math

Obsidian uses MathJax/KaTeX:

Inline math:

$E = mc^2$

Block math:

$$
\int_0^\infty e^{-x} dx = 1
$$

Code Blocks

Standard fenced code blocks. Obsidian highlights all common languages:

```python
def hello():
    return "world"
```

Tables

Standard Markdown tables:

| Column A | Column B | Column C |
|----------|----------|----------|
| Value    | Value    | Value    |
| Value    | Value    | Value    |

Obsidian renders tables natively. No plugin needed.


Mermaid Diagrams

Obsidian renders Mermaid natively:

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[End]
    B -->|No| D[Loop]
    D --> A
```

Supported: graph, sequenceDiagram, gantt, classDiagram, pie, flowchart.


Footnotes

This sentence has a footnote.[^1]

[^1]: The footnote text goes here.

What NOT to Do

  • Do not use [link text](path/to/note.md) for internal links: use [[Note Name]] instead.
  • Do not use HTML inside callouts: stick to Markdown.
  • Do not use ## inside a callout body: headings don't render inside callouts.
  • Do not write tags: [a, b, c] inline in frontmatter: Obsidian prefers the list format.
  • Do not write ISO datetimes in frontmatter (2026-04-08T00:00:00Z): use 2026-04-08.

How to think (10-principle mapping)

When working on this skill, apply the 10-principle loop. See skills/think/SKILL.md for the canonical framework.

#PrincipleApplication here
1OBSERVE (ext)Which syntax does the user need? (Wikilinks? Callouts? Embeds? Math? Mermaid?)
2OBSERVE (int)Am I documenting Obsidian Flavored Markdown as I remember it or as it currently is? Check the spec.
3LISTENThe user's source-of-confusion — what specific syntax did they get wrong?
4THINKMinimal correct examples. "What NOT to do" is often as valuable as "what to do."
5CONNECT (lat)How does OFM differ from CommonMark and GFM? The deltas are where users get confused.
6CONNECT (sys)Substrate-defer to kepano/obsidian-skills when present — single source of truth, less drift.
7FEELA cheat sheet that's scannable in 30 seconds, not a wall of text.
8ACCEPTNot every wikilink needs an alias; some syntax is genuinely optional. Don't over-prescribe.
9CREATESyntax reference, current to Obsidian X.Y. Include the gotchas section.
10GROWAs OFM evolves (newer Mermaid types, callout types, cssclasses, etc.), refresh.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.