Index of every page on this site: llms.txt
All skills
obsidianmd avatar

/obsidian-markdown

@b110b2f
by Obsidianobsidianmd/obsidian-skills53k stars
3,795
Run it yourself

Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax. Use when working with .md files in Obsidian, or when the user mentions wikilinks, callouts, frontmatter, tags, embeds, or Obsidian notes.

Use this Skill: https://skilld.dev/gh/obsidianmd/obsidian-skills/obsidian-markdown

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈70 tokens for metadata: the name and description. ≈1.5k when used: this file. ≈890 more on demand in 3 files.

Description uses 3.5% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈282 characters, or 3.5%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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

Inside Markdown tables, escape wikilink alias pipes as [[Note\|Alias]] so the alias separator is not parsed as a table cell delimiter. When a table follows a paragraph, leave a blank line above it, or it renders as plain text.

Links resolve by file name, not by the aliases property. A bare [[Alias]] stays unresolved; write [[Note|Alias]] to show an alias.

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 names offered in link suggestions; links still use the file name), 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, underscores, hyphens, and forward slashes, but must include at least one non-numerical character (#1984 is invalid, #1984book is valid). A space ends a tag, so #my tag is the tag #my. 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
==🔴Highlighted text==                 Colored highlight (Obsidian 1.14.1 and later)

A colored highlight starts with 🔴, 🟠, 🟡, 🟢, 🔵 or 🟣 (or the matching square) right after ==. Other emoji stay as text.

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: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts7d3 checks · Risk SAFE
  • Gen Agent Trust Hub7d

    This skill provides instructions and syntax for creating Obsidian Flavored Markdown notes. It contains no executable code or malicious patterns.

  • Socket7d

    No alerts

  • Snyk7d

    Risk: LOW · No issues

Signed by skilld at b110b2f. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 12 hours ago.

Activeupdated 2 weeks ago
  • obsidian
  • markdown
  • wikilinks
  • embeds
  • callouts
  • frontmatter
  • properties
  • note-taking
  • internal-links

README badge

README badge for obsidianmd/obsidian-skills/obsidian-markdown

Creates and edits Obsidian Flavored Markdown files with wikilinks, embeds, callouts, properties, and block references. Use this skill when working with .md files in Obsidian vaults or when the user requests Obsidian-specific syntax like internal links, frontmatter properties, or embedded content.

Generated from the current SKILL.md.

Does this skill cover standard Markdown syntax?
No. This skill focuses only on Obsidian-specific extensions like wikilinks, embeds, callouts, and properties. Standard Markdown (headings, bold, italic, lists, code blocks, tables) is assumed knowledge.
When should I use wikilinks vs. standard Markdown links?
Use wikilinks (`[[Note Name]]`) for notes within your Obsidian vault — Obsidian tracks renames automatically. Use standard Markdown links (`[text](url)`) for external URLs only.
Can I embed images and PDFs?
Yes. Use the `![[image.png|width]]` syntax for images and `![[document.pdf#page=3]]` for specific PDF pages. See EMBEDS.md for audio, video, and external image syntax.
What callout types are available?
Common types include note, tip, warning, info, example, quote, bug, danger, success, failure, question, abstract, and todo. Callouts can have custom titles and be collapsed or expanded by default. See CALLOUTS.md for the full list.
How do I add metadata to a note?
Use YAML frontmatter at the top of the file with properties like title, tags, aliases, date, and cssclasses. See PROPERTIES.md for all available property types.

Generated from the current SKILL.md. These answers refresh after source changes.