
Obsidian Flavored Markdown
FreeCreate and edit Obsidian-specific Markdown effortlessly.
Free · Opens the source repo
What Obsidian Flavored Markdown does
The Obsidian Flavored Markdown skill allows users to create and edit Markdown files tailored specifically for use within Obsidian, a popular note-taking application. This skill focuses on the unique features that Obsidian adds to standard Markdown, such as wikilinks, embeds, callouts, and properties, enabling users to leverage these extensions effectively. By using this skill, you can ensure that your Markdown files are not only valid but also optimized for the Obsidian environment.
To get started, you can add frontmatter to your notes, which includes metadata like titles, tags, and aliases. This is essential for organizing and retrieving notes within Obsidian. The skill guides you through using standard Markdown for structuring your content while incorporating Obsidian-specific syntax for enhanced functionality. For instance, you can create internal links using wikilinks, allowing seamless navigation between related notes, or embed images and PDFs directly into your notes using the appropriate syntax.
Moreover, the skill covers advanced features such as callouts for highlighting important information and properties for categorizing your notes. This makes it particularly useful for users who are looking to enhance their note-taking workflow with rich formatting options. Whether you are a developer documenting your projects or a designer organizing your ideas, this skill provides the tools necessary to create well-structured and visually appealing notes in Obsidian.
Overall, this skill is designed for anyone who uses Obsidian for note-taking and wants to utilize its extended Markdown capabilities fully. By following the provided instructions, you can create notes that are not only informative but also interactive and interconnected, making your knowledge management more efficient.
When to use it
Use this skill when working with Markdown files in Obsidian, especially when you need to incorporate its specific syntax like wikilinks and embeds.
When not to use it
This skill is not suitable for general Markdown editing outside of Obsidian or for users unfamiliar with Markdown syntax.
What you can build with it
Creating a Project Note
Use this skill to create a detailed project note in Obsidian, including frontmatter for tags and status, and embed relevant diagrams.
Linking Research Notes
Effortlessly link your research notes using wikilinks to create a network of interconnected ideas and references.
Highlighting Important Information
Utilize callouts to emphasize key deadlines or important notes in your Obsidian documents, making them stand out for quick reference.
How to install Obsidian Flavored Markdown
View source1. Install with the skills CLI
npx skills add kepano/obsidian-skills/obsidian-markdown --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by kepanoObsidian 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
- Add 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. - Add callouts for highlighted information using
> [!type]syntax. See CALLOUTS.md for all callout types. - 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
Frequently asked questions about Obsidian Flavored Markdown
Similar skills
Napkin
Collaborate visually with Copilot using an interactive whiteboard.
Mode Creator
Custom note-taking modes for claude-mem.
Google Meet Assistant
Join, transcribe, and interact in Google Meet calls.
Memory Keeper
Organize lessons learned into reusable knowledge.
Meeting Minutes
Generate concise, actionable meeting minutes effortlessly.
Brag Sheet
Transform your work into impactful statements for reviews.
