Obsidian Markdown

davila7/claude-code-templates/cli-tool/components/skills/document-processing/obsidian-markdown

作者 davila78da17d671b6f无许可证32K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库今天更新

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.

仅含说明Writing & Content
AI 生成的概览

用于编写和编辑 Obsidian 风格 Markdown 的参考,涵盖 wikilink、嵌入、标注、属性等 Obsidian 语法。

功能
提供创建和编辑有效 Obsidian 风格 Markdown 笔记的语法指导。内容涵盖基础格式、wikilink、嵌入、标注、列表、表格、LaTeX 数学公式、Mermaid 图表、脚注、注释、属性与标签,并配有示例。产出的是结构正确的 Markdown 内容,而非文件或脚本。
适用场景
适用于编写或编辑面向 Obsidian 的 .md 文件,或任务涉及 wikilink、标注、frontmatter 属性、标签、嵌入等 Obsidian 专有语法时。
运行要求
无需工具、软件包或凭据;仅为说明文档,不附带脚本。

Obsidian Flavored Markdown Skill

This skill enables Claude Code to create and edit valid Obsidian Flavored Markdown, including all Obsidian-specific syntax extensions.

Overview

Obsidian uses a combination of Markdown flavors:

Basic Formatting

Paragraphs and Line Breaks

markdown
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

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

Text Formatting

StyleSyntaxExampleOutput
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:

markdown
\*This won't be italic\*\#This won't be a heading1\. This won't be a list item

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

Internal Links (Wikilinks)

Basic Links

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

Link to Headings

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

Link to Blocks

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

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

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

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

markdown
> This is a quote> With multiple lines
^quote-id

Search Links

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

Markdown-Style Links

markdown
[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

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

Embed Images

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

External Images

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

Embed Audio

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

Embed PDF

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

Embed Lists

markdown
![[Note#^list-id]]

Where the list has been defined with a block ID:

markdown
- Item 1- Item 2- Item 3
^list-id

Embed Search Results

markdown
```querytag:#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

markdown
> [!faq]- Collapsed by default> This content is hidden until expanded.
> [!faq]+ Expanded by default> This content is visible but can be collapsed.

Nested Callouts

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

Supported Callout Types

TypeAliasesDescription
note-Blue, pencil icon
abstractsummary, tldrTeal, clipboard icon
info-Blue, info icon
todo-Blue, checkbox icon
tiphint, importantCyan, flame icon
successcheck, doneGreen, checkmark icon
questionhelp, faqYellow, question mark
warningcaution, attentionOrange, warning icon
failurefail, missingRed, X icon
dangererrorRed, zap icon
bug-Red, bug icon
example-Purple, list icon
quoteciteGray, quote icon

Custom Callouts (CSS)

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

Lists

Unordered Lists

markdown
- Item 1- Item 2  - Nested item  - Another nested- Item 3
* Also works with asterisks+ Or plus signs

Ordered Lists

markdown
1. First item2. Second item   1. Nested numbered   2. Another nested3. Third item
1) Alternative syntax2) With parentheses

Task Lists

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

Quotes

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

Code

Inline Code

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

Code Blocks

markdown
```Plain code block```
```javascript// Syntax highlighted code blockfunction hello() {  console.log("Hello, world!");}```
```python# Python exampledef greet(name):    print(f"Hello, {name}!")```

Nesting Code Blocks

Use more backticks or tildes for the outer block:

markdown
````markdownHere's how to create a code block:```jsconsole.log("Hello")```````

Tables

markdown
| Header 1 | Header 2 | Header 3 ||----------|----------|----------|| Cell 1   | Cell 2   | Cell 3   || Cell 4   | Cell 5   | Cell 6   |

Alignment

markdown
| Left     | Center   | Right    ||:---------|:--------:|---------:|| Left     | Center   | Right    |

Using Pipes in Tables

Escape pipes with backslash:

markdown
| Column 1 | Column 2 ||----------|----------|| [[Link\|Display]] | ![[Image\|100]] |

Math (LaTeX)

Inline Math

markdown
This is inline math: $e^{i\pi} + 1 = 0$

Block Math

markdown
$$\begin{vmatrix}a & b \\c & d\end{vmatrix} = ad - bc$$

Common Math Syntax

markdown
$x^2$              Superscript$x_i$              Subscript$\frac{a}{b}$      Fraction$\sqrt{x}$         Square root$\sum_{i=1}^{n}$   Summation$\int_a^b$         Integral$\alpha, \beta$    Greek letters

Diagrams (Mermaid)

markdown
```mermaidgraph TD    A[Start] --> B{Decision}    B -->|Yes| C[Do this]    B -->|No| D[Do that]    C --> E[End]    D --> E```

Sequence Diagrams

markdown
```mermaidsequenceDiagram    Alice->>Bob: Hello Bob    Bob-->>Alice: Hi Alice```

Linking in Diagrams

markdown
```mermaidgraph TD    A[Biology]    B[Chemistry]    A --> B    class A,B internal-link;```

Footnotes

markdown
This sentence has a footnote[^1].
[^1]: This is the footnote content.
You can also use named footnotes[^note].
[^note]: Named footnotes still appear as numbers.
Inline footnotes are also supported.^[This is an inline footnote.]

Comments

markdown
This is visible %%but this is hidden%% text.
%%This entire block is hidden.It won't appear in reading view.%%

Horizontal Rules

markdown
---***___- - -* * *

Properties (Frontmatter)

Properties use YAML frontmatter at the start of a note:

yaml
---title: My Note Titledate: 2024-01-15tags:  - project  - importantaliases:  - My Note  - Alternative Namecssclasses:  - custom-classstatus: in-progressrating: 4.5completed: falsedue: 2024-02-01T14:30:00---

Property Types

TypeExample
Texttitle: My Title
Numberrating: 4.5
Checkboxcompleted: true
Datedate: 2024-01-15
Date & Timedue: 2024-01-15T14:30:00
Listtags: [one, two] or YAML list
Linksrelated: "[[Other Note]]"

Default Properties

  • tags - Note tags
  • aliases - Alternative names for the note
  • cssclasses - CSS classes applied to the note

Tags

markdown
#tag#nested/tag#tag-with-dashes#tag_with_underscores
In frontmatter:---tags:  - tag1  - nested/tag2---

Tags can contain:

  • Letters (any language)
  • Numbers (not as first character)
  • Underscores _
  • Hyphens -
  • Forward slashes / (for nesting)

HTML Content

Obsidian supports HTML within Markdown:

markdown
<div class="custom-container">  <span style="color: red;">Colored text</span></div>
<details>  <summary>Click to expand</summary>  Hidden content here.</details>
<kbd>Ctrl</kbd> + <kbd>C</kbd>

Complete Example

markdown
---title: Project Alphadate: 2024-01-15tags:  - project  - activestatus: in-progresspriority: high---
# Project Alpha
## Overview
This project aims to [[improve workflow]] using modern techniques.
> [!important] Key Deadline> The first milestone is due on ==January 30th==.
## Tasks
- [x] Initial planning- [x] Resource allocation- [ ] Development phase  - [ ] Backend implementation  - [ ] Frontend design- [ ] Testing- [ ] Deployment
## Technical Notes
The main algorithm uses the formula $O(n \log n)$ for sorting.
```pythondef process_data(items):    return sorted(items, key=lambda x: x.priority)```
## Architecture
```mermaidgraph LR    A[Input] --> B[Process]    B --> C[Output]    B --> D[Cache]```
## Related Documents
- ![[Meeting Notes 2024-01-10#Decisions]]- [[Budget Allocation|Budget]]- [[Team Members]]
## References
For more details, see the official documentation[^1].
[^1]: https://example.com/docs
%%Internal notes:- Review with team on Friday- Consider alternative approaches%%

References

来源与署名

来源:davila7/claude-code-templates位于cli-tool/components/skills/document-processing/obsidian-markdown提交8da17d6

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架