mcpField
O
obsidian-markdown

obsidian-markdown

github.com/galaxy-dawn生产力5.9k47 次安装1 周前更新
代码仓库

关于 obsidian-markdown

用于创建和编辑 Obsidian Flavored Markdown 笔记的技能，涵盖链接、嵌入、标注、属性等 Obsidian 专属语法。

主要功能

  1. 01创建和编辑 Obsidian Markdown
  2. 02使用维基链接和嵌入
  3. 03添加标注和 frontmatter 属性
  4. 04设置标签、注释和高亮
  5. 05编写 Mermaid 图表和 LaTeX 数学公式

适用场景

  1. 01创建结构化 Obsidian 笔记
  2. 02链接或嵌入库中的相关内容

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/galaxy-dawn/claude-scholar --skill obsidian-markdown

安装后在 Claude Code 中输入/obsidian-markdown确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
CALLOUTS.md
EMBEDS.md
PROPERTIES.md

详细介绍

Obsidian Flavored Markdown 技能

创建和编辑有效的 Obsidian Flavored Markdown。Obsidian 在 CommonMark 和 GFM 的基础上扩展了 wikilink、嵌入、标注、属性、注释及其他语法。本技能仅涵盖 Obsidian 特有的扩展 —— 标准 Markdown（标题、粗体、斜体、列表、引用、代码块、表格）属于假定已掌握的知识。

工作流：创建 Obsidian 笔记

  1. 添加 frontmatter：在文件顶部添加包含属性（title、tags、aliases）的 frontmatter。所有属性类型请参阅 PROPERTIES.md。
  2. 撰写内容：使用标准 Markdown 构建结构，并结合下方 Obsidian 特有的语法。
  3. 链接相关笔记：使用 wikilink（[[Note]]）建立库内连接，或使用标准 Markdown 链接指向外部 URL。
  4. 嵌入内容：使用 ![[embed]] 语法嵌入其他笔记、图片或 PDF 的内容。所有嵌入类型请参阅 EMBEDS.md。
  5. 添加标注：使用 > [!type] 语法突出显示信息。所有标注类型请参阅 CALLOUTS.md。
  6. 验证：确认笔记在 Obsidian 的阅读视图中正确渲染。

在 wikilink 和 Markdown 链接之间做选择时：库内笔记使用 [[wikilinks]]（Obsidian 会自动跟踪重命名），仅外部 URL 使用 [text](url)。

内部链接（Wikilink）

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

在任何段落末尾追加 ^block-id 即可定义块 ID：

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

对于列表和引用，将块 ID 放在块之后单独的一行：

> A quote block

^quote-id

嵌入

在任何 wikilink 前加上 ! 即可将其内容内联嵌入：

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

音频、视频、搜索嵌入和外部图片请参阅 EMBEDS.md。

标注

> [!note]
> Basic callout.

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

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

常见类型：note、tip、warning、info、example、quote、bug、danger、success、failure、question、abstract、todo。

包含别名、嵌套和自定义 CSS 标注的完整列表请参阅 CALLOUTS.md。

属性（Frontmatter）

---
title: My Note
date: 2024-01-15
tags:
  - project
  - active
aliases:
  - Alternative Name
cssclasses:
  - custom-class
---

默认属性：tags（可搜索的标签）、aliases（用于链接建议的备用笔记名称）、cssclasses（用于样式的 CSS 类）。

所有属性类型、标签语法规则及高级用法请参阅 PROPERTIES.md。

标签

#tag                    Inline tag
#nested/tag             Nested tag with hierarchy

标签可包含字母、数字（不能作为首字符）、下划线、连字符和正斜杠。标签也可在 frontmatter 的 tags 属性中定义。

注释

This is visible %%but this is hidden%% text.

%%
This entire block is hidden in reading view.
%%

Obsidian 特有格式

==Highlighted text==                   Highlight syntax

数学公式（LaTeX）

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

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

图表（Mermaid）

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

要将 Mermaid 节点链接到 Obsidian 笔记，请添加 class NodeName internal-link;。

脚注

Text with a footnote[^1].

[^1]: Footnote content.

Inline footnote.^[This is inline.]

完整示例

---
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]].

参考资料

评论

支持 Markdown