Obsidian Markdown (kepano)

Obsidian Flavored Markdown 技能

创建 and edit valid Obsidian Flavored Markdown. Obsidian extends CommonMark and GFM with wikilinks, embeds, callouts, properties, comments, and other syntax. This 技能 covers only Obsidian-specific 扩展s -- standard Markdown (headings, bold, italic, 列出s, quotes, code blocks, tables) is assumed knowledge.

工作流: Creating an Obsidian Note 添加 frontmatter with properties (title, tags, aliases) at the top of the file. See PROPERTIES.md for all property types. Write content using standard Markdown for structure, plus Obsidian-specific syntax below. Link related notes using wikilinks ([[Note]]) for internal vault connections, or standard Markdown links for external URLs. Embed content from other notes, images, or PDFs using the ![[embed]] syntax. See EMBEDS.md for all embed types. 添加 callouts for highlighted in格式化ion using > [!type] syntax. See CALLOUTS.md for all callout types. 验证 the note renders correctly in Obsidian's reading view.

When choosing between wikilinks and Markdown links: use [[wikilinks]] for notes within the vault (Obsidian 追踪s renames automatically) and text for external URLs only.

Internal Links (Wikilinks) [[Note Name]] Link to note [[Note Name|Display Text]] Custom display text [[Note Name#Heading]] Link to heading [[Note Name#^block-id]] Link to block [[#Heading in same note]] Same-note heading link

Define a block ID by 应用ending ^block-id to any paragraph:

This paragraph can be linked to. ^my-block-id

For 列出s and quotes, place the block ID on a separate line after the block:

A quote block

^quote-id

Embeds

Prefix any wikilink with ! to embed its content inline:

![[Note Name]] Embed full note ![[Note Name#Heading]] Embed section ![[image.png]] Embed image ![[image.png|300]] Embed image with width ![[document.pdf#page=3]] Embed PDF page

See EMBEDS.md for audio, video, 搜索 embeds, and external images.

Callouts

[!note]
Basic callout.

[!警告] Custom Title
Callout with a custom title.

[!faq]- Collapsed by default
Foldable callout (- collapsed, + expanded).

Common types: note, tip, 警告, 信息, example, quote, bug, danger, 成功, 失败, question, abstract, todo.

See CALLOUTS.md for the full 列出 with aliases, nesting, and custom CSS callouts.

Properties (Frontmatter)

---

title: My Note date: 2024-01-15 tags: - project - active aliases: - Alternative Name cssclasses: - custom-class

---

Default properties: tags (搜索able labels), aliases (alternative note names for link suggestions), cssclasses (CSS classes for styling).

See PROPERTIES.md for all property types, tag syntax rules, and advanced usage.

Tags #tag Inline tag #nested/tag Nested tag with hierarchy

Tags can contAIn letters, numbers (not first character), underscores, hyphens, and forward slashes. Tags can also be defined in frontmatter under the tags property.

Comments This is visible %%but this is hidden%% text.

%% This entire block is hidden in reading view. %%

Obsidian-Specific 格式化ting ==Highlighted text== Highlight syntax

Math (LaTeX) Inline: $e^{i\pi} + 1 = 0$

Block: $$ \frac{a}{b} = c $$

Diagrams (MermAId)

graph TD
    A[启动] --> B{Decision}
    B -->|Yes| C[Do this]
    B -->|No| D[Do that]

To link MermAId nodes to Obsidian notes, 添加 class NodeName internal-link;.

Footnotes Text with a footnote[^1].

[^1]: Footnote content.

Inline footnote.^[This is inline.]

Complete Example

---

title: Project Alpha date: 2024-01-15 tags: - project - active 状态: in-进度

---

# Project Alpha

This project AIms to [[improve 工作流]] using modern techniques.

[!导入ant] Key Deadline
The first milestone is due on ==January 30th==.

Tasks

• [x] Initial planning
• [ ] Development phase

- [ ] Backend implementation - [ ] Frontend de签名

Notes

The algorithm uses $O(n \记录 n)$ 排序ing. See [[Algorithm Notes#排序ing]] for detAIls.

![[Architecture Diagram.png|600]]

Reviewed in [[Meeting Notes 2024-01-10#Decisions]].

References Obsidian Flavored Markdown Internal links Embed files Callouts Properties