XzhLoongSkills/xzh-obsidian-llm-wiki/references/obsidian-markdown.md

Obsidian Markdown Reference

Frontmatter

Use YAML frontmatter for durable wiki pages:

---
title: Example Page
tags:
  - topic
  - domain/example
type: topic
status: evergreen
created: 2026-04-25
updated: 2026-04-25
aliases:
  - Alternate Name
sources:
  - "[[source-example]]"
---

Common fields:

• title: display title.
• tags: graph and search labels.
• aliases: alternate names used by Obsidian link suggestions.
• type: topic, module, concept, entity, source, query, learning.
• status: seed, draft, evergreen, needs-review, deprecated.
• sources: wikilinks or external citations.

Follow the vault's existing property names when they differ.

Wikilinks

[[Note Name]]
[[Note Name|Label]]
[[Note Name#Heading]]
[[Note Name#^block-id]]
[[#Heading In Same Note]]

Rules:

• Use wikilinks for internal vault relationships.
• Use heading links for review paths and precise references.
• Use aliases when the display text should differ from the filename.
• Prefer bidirectional linking when both pages benefit.

Embeds

![[Note Name]]
![[Note Name#Heading]]
![[image.png]]
![[image.png|300]]
![[document.pdf#page=3]]

Use embeds for images, PDFs, audio, video, selected note sections, and reusable examples. Keep attachment paths stable.

Callouts

> [!abstract]
> Page purpose or short summary.

> [!warning] Conflict
> Source A and Source B disagree on this claim.

> [!question]- Socratic Review
> What assumption makes this argument work?

> [!example] Counterexample
> A case where the rule fails.

Useful types: abstract, info, tip, warning, question, example, quote, todo, success, failure, danger.

Mermaid

Use Mermaid for flow, hierarchy, sequence, state, and causal diagrams.

```mermaid
flowchart LR
    Source[Source] --> Concept[Concept Page]
    Concept --> Drill[Judgment Drill]
    Concept --> Index[Index]
```

KaTeX

Inline: $f(x)=\sum_i w_i x_i$

$$
P(A \mid B)=\frac{P(B \mid A)P(A)}{P(B)}
$$

Bases And Dataview-Like Views

When the vault uses Obsidian Bases or Dataview-style metadata, keep properties consistent so pages can be queried by type, status, tags, updated, and sources.

Use structured views for:

• source inventories
• concepts needing review
• unresolved audit items
• learning drills by topic
• reading paths

Canvas

Use JSON Canvas when a spatial overview helps more than a linear note:

• topic maps
• argument maps
• debate maps
• book structure maps
• concept dependency graphs

Keep Canvas nodes linked to real Markdown pages whenever possible.

Quality Checklist

• Frontmatter parses.
• Internal links use wikilinks.
• External URLs use standard Markdown links.
• Embeds resolve in Obsidian.
• Callouts use supported types.
• Mermaid and formulas are fenced correctly.
• Headings do not skip levels.
• Teaching pages include questions or exercises, not just summaries.