Get the FREE Ultimate OpenClaw Setup Guide →

obsidian-markdown

npx machina-cli add skill guanyang/antigravity-skills/obsidian-markdown --openclaw
Files (1)
SKILL.md
5.2 KB

Obsidian Flavored Markdown Skill

Create and edit valid Obsidian Flavored Markdown. Obsidian extends CommonMark and GFM with wikilinks, embeds, callouts, properties, comments, and other syntax. This skill covers only Obsidian-specific extensions -- standard Markdown (headings, bold, italic, lists, quotes, code blocks, tables) is assumed knowledge.

Workflow: Creating an Obsidian Note

  1. Add frontmatter with properties (title, tags, aliases) at the top of the file. See PROPERTIES.md for all property types.
  2. Write content using standard Markdown for structure, plus Obsidian-specific syntax below.
  3. Link related notes using wikilinks ([[Note]]) for internal vault connections, or standard Markdown links for external URLs.
  4. Embed content from other notes, images, or PDFs using the ![[embed]] syntax. See EMBEDS.md for all embed types.
  5. Add callouts for highlighted information using > [!type] syntax. See CALLOUTS.md for all callout types.
  6. Verify the note renders correctly in Obsidian's reading view.

When choosing between wikilinks and Markdown links: use [[wikilinks]] for notes within the vault (Obsidian tracks renames automatically) and [text](url) 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 appending ^block-id to any paragraph:

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

For lists 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, search embeds, and external images.

Callouts

> [!note]
> Basic callout.

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

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

Common types: note, tip, warning, info, example, quote, bug, danger, success, failure, question, abstract, todo.

See CALLOUTS.md for the full list 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 (searchable 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 Formatting

==Highlighted text==                   Highlight syntax

Math (LaTeX)

Inline: $e^{i\pi} + 1 = 0$

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

Diagrams (Mermaid)

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Do this]
    B -->|No| D[Do that]
```

To link Mermaid nodes to Obsidian notes, add 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
status: in-progress
---

# Project Alpha

This project aims to [[improve workflow]] using modern techniques.

> [!important] Key Deadline
> The first milestone is due on ==January 30th==.

## Tasks

- [x] Initial planning
- [ ] Development phase
  - [ ] Backend implementation
  - [ ] Frontend design

## Notes

The algorithm uses $O(n \log n)$ sorting. See [[Algorithm Notes#Sorting]] for details.

![[Architecture Diagram.png|600]]

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

References

Source

git clone https://github.com/guanyang/antigravity-skills/blob/main/skills/obsidian-markdown/SKILL.mdView on GitHub

Overview

This skill covers creating and editing Obsidian Flavored Markdown (OFMarkdown) with Obsidian-specific extensions such as wikilinks, embeds, callouts, properties, and comments. It focuses on .md files in Obsidian and when to use features like frontmatter, tags, and embeds to connect notes within a vault.

How This Skill Works

You start by adding YAML frontmatter at the top for properties like title, tags, and aliases. Then write standard Markdown for structure, augmented by Obsidian-specific syntax: wikilinks [[Note]], embeds ![[Note]] or ![[image.png]], and callouts > [!type]. You can define block IDs with ^block-id for linking to specific paragraphs, and use tags in frontmatter or inline. Verify rendering in Obsidian’s reading view to ensure everything displays as intended, including highlighted text using Obsidian’s formatting (e.g., ==highlight==).

When to Use It

  • When working with Obsidian vaults and .md notes that require internal linking
  • When you want to embed content from another note, image, or PDF
  • When you need structured metadata like title, tags, or aliases at the top of a note
  • When you want to highlight or categorize content with callouts or comments
  • When referencing specific sections or blocks within notes using block IDs or headings

Quick Start

  1. Step 1: Add frontmatter at the top of your .md file with title, tags, and aliases
  2. Step 2: Write content using standard Markdown, then add Obsidian-specific elements like [[Note]] links, ![[Note]] embeds, and > [!type] callouts
  3. Step 3: Validate in Obsidian reading view and adjust block IDs or highlighting as needed

Best Practices

  • Add frontmatter at the very top of the file with essential properties (title, tags, aliases) for better linking and searchability
  • Use wikilinks ([[Note]]) for vault notes and [text](url) for external links only
  • Leverage embeds (![[Note]] or ![[image.png]]) to reuse content without duplicating text
  • Incorporate callouts (> [!type]) to emphasize important information and use consistent types
  • Verify rendering in Obsidian’s reading view, including any highlights like ==text==

Example Use Cases

  • Create a note with frontmatter: --- title: Project Plan, tags: [planning], aliases: [Plan A] ---
  • Embed a related note: ![[Overview]] to show content inline
  • Link to a heading: [[Requirements#Acceptance Criteria]]
  • Define and link to a block: This paragraph.^block-id followed by ^block-id on its own line for quotes or lists
  • Add a callout: > [!note] Remember to save changes before exiting

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers ↗