/obsidian-markdown

name: obsidian-markdown
description: 技术写作员与内容创作者在构建Obsidian知识库时，当需要编写带双向链接、Callout或Frontmatter的复杂笔记，使用此技能可精准生成标准Markdown文档，完美支持wikilinks与嵌入，大幅提升知识管理与排版效率！

Obsidian Flavored Markdown Skill

This skill enables skills-compatible agents to create and edit valid Obsidian Flavored Markdown, including all Obsidian-specific syntax extensions.

Overview

Obsidian uses a combination of Markdown flavors:

• [CommonMark](https://commonmark.org/)
• [GitHub Flavored Markdown](https://github.github.com/gfm/)
• [LaTeX](https://www.latex-project.org/) for math
• Obsidian-specific extensions (wikilinks, callouts, embeds, etc.)

Basic Formatting

Paragraphs and Line Breaks

This is a paragraph.

This is another paragraph (blank line between creates separate paragraphs).

For a line break within a paragraph, add two spaces at the end  
or use Shift+Enter.

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Text Formatting

| Style | Syntax | Example | Output | |-------|--------|---------|--------| | Bold | `**text**` or `__text__` | `**Bold**` | **Bold** | | Italic | `*text*` or `_text_` | `*Italic*` | *Italic* | | Bold + Italic | `***text***` | `***Both***` | ***Both*** | | Strikethrough | `~~text~~` | `~~Striked~~` | ~~Striked~~ | | Highlight | `==text==` | `==Highlighted==` | ==Highlighted== | | Inline code | `` `code` `` | `` `code` `` | `code` |

Escaping Formatting

Use backslash to escape special characters:

\*This won't be italic\*
\#This won't be a heading
1\. This won't be a list item

Common characters to escape: `\*`, `\_`, `\#`, `` \` ``, `\|`, `\~`

Internal Links (Wikilinks)

Basic Links

[[Note Name]]
[[Note Name.md]]
[[Note Name|Display Text]]

Link to Headings

[[Note Name#Heading]]
[[Note Name#Heading|Custom Text]]
[[#Heading in same note]]
[[##Search all headings in vault]]

Link to Blocks

[[Note Name#^block-id]]
[[Note Name#^block-id|Custom Text]]

Define a block ID by adding `^block-id` at the end of a paragraph:

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

For lists and quotes, add the block ID on a separate line:

> This is a quote
> With multiple lines

^quote-id

Search Links

[[##heading]]     Search for headings containing "heading"
[[^^block]]       Search for blocks containing "block"

Markdown-Style Links

[Display Text](Note%20Name.md)
[Display Text](Note%20Name.md#Heading)
[Display Text](https://example.com)
[Note](obsidian://open?vault=VaultName&file=Note.md)

Note: Spaces must be URL-encoded as `%20` in Markdown links.

Embeds

Embed Notes

![[Note Name]]
![[Note Name#Heading]]
![[Note Name#^block-id]]

Embed Images

![[image.png]]
![[image.png|640x480]]    Width x Height
![[image.png|300]]        Width only (maintains aspect ratio)

External Images

![Alt text](https://example.com/image.png)
![Alt text|300](https://example.com/image.png)

Embed Audio

![[audio.mp3]]
![[audio.ogg]]

Embed PDF

![[document.pdf]]
![[document.pdf#page=3]]
![[document.pdf#height=400]]

Embed Lists

![[Note#^list-id]]

Where the list has been defined with a block ID:

- Item 1
- Item 2
- Item 3

^list-id

Embed Search Results

```query
tag:#project status:done

## Callouts

### Basic Callout

```markdown
> [!note]
> This is a note callout.

> [!info] Custom Title
> This callout has a custom title.

> [!tip] Title Only

Foldable Callouts

> [!faq]- Collapsed by default
> This content is hidden until expanded.

> [!faq]+ Expanded by default
> This content is visible but can be collapsed.

Nested Callouts

> [!question] Outer callout
> > [!note] Inner callout
> > Nested content

Supported Callout Types

| Type | Aliases | Description | |------|---------|-------------| | `note` | - | Blue, pencil icon | | `abstract` | `summary`, `tldr` | Teal, clipboard icon | | `info` | - | Blue, info icon | | `todo` | - | Blue, checkbox icon | | `tip` | `hint`, `important` | Cyan, flame icon | | `success` | `check`, `done` | Green, checkmark icon | | `question` | `help`, `faq` | Yellow, question mark | | `warning` | `caution`, `attention` | Orange, warning icon | | `failure` | `fail`, `missing` | Red, X icon | | `danger` | `error` | Red, zap icon | | `bug` | - | Red, bug icon | | `example` | - | Purple, list icon | | `quote` | `cite` | Gray, quote icon |

Custom Callouts (CSS)

.callout[data-callout="custom-type"] {
  --callout-color: 255, 0, 0;
  --callout-icon: lucide-alert-circle;
}

Lists

Unordered Lists

- Item 1
- Item 2
  - Nested item
  - Another nested
- Item 3

* Also works with asterisks
+ Or plus signs

Ordered Lists

1. First item
2. Second item
   1. Nested numbered
   2. Another nested
3. Third item

1) Alternative syntax
2) With parentheses

Task Lists

- [ ] Incomplete task
- [x] Completed task
- [ ] Task with sub-tasks
  - [ ] Subtask 1
  - [x] Subtask 2

Quotes

> This is a blockquote.
> It can span multiple lines.
>
> And include multiple paragraphs.
>
> > Nested quotes work too.

Code

Inline Code

Use `backticks` for inline code.
Use double backticks for ``code with a ` backtick inside``.

Code Blocks

Plain code block

```javascript
// Syntax highlighted code block
function hello() {
  console.log("Hello, world!");
}

# Python example
def greet(name):
    print(f"Hello, {name}!")

### Nesting Code Blocks

Use more backticks or tildes for the outer block:

`````markdown
````markdown
Here's how to create a code block:
```js
console.log("Hello")

``