mcpField
O
obsidian-markdown

obsidian-markdown

github.com/agricidaniel生产力16.0k546 次安装1 周前更新
代码仓库

关于 obsidian-markdown

obsidian-markdown 是用于解答 Obsidian 专属 Markdown 语法问题的技能,提供精简参考;遇到细节或版本相关问题时,建议查阅已安装的 `kepano/obsidian-skills` 技能或当前 Obsidian 帮助文档。

主要功能

  1. 01Obsidian 语法参考
  2. 02只读语法答疑
  3. 03YAML 属性规范指导
  4. 04双链、嵌入与标注块说明
  5. 05安全的知识库编辑事务指导

适用场景

  1. 01查询 Obsidian 笔记语法
  2. 02检查 YAML 属性约定
  3. 03起草经批准的 Markdown 知识库编辑

安装

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

$npx skills add https://github.com/agricidaniel/claude-obsidian --skill obsidian-markdown

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

详细介绍

Obsidian 风格 Markdown

将此内容用作 Obsidian 专属语法的简明备用参考。若有单独安装的 kepano/obsidian-skills obsidian-markdown 技能,请优先使用;对于详细 或与版本相关的问题,再查阅最新的 Obsidian Help。

根据此技能自身的位置解析已安装产品的根目录,而不是根据 库或当前工作目录:

PRODUCT_ROOT=/absolute/path/to/installed/claude-obsidian
CORE="$PRODUCT_ROOT/scripts/claude-obsidian.py"
test -f "$CORE"

本文件中的每个 ../wiki/references/ 链接都以相同方式解析,路径相对于 $PRODUCT_ROOT 下此技能自身的目录,绝不相对于 所选库的 wiki/ 目录。

以只读方式回答语法问题。如果用户要求编辑库,先起草完整笔记,阅读 operation-transactions.md, 并构建一个 claude-obsidian.transaction.v1 捆绑包,其中 operation_type: markdown,且目标仅限于 wiki/。检查该捆绑包,然后在审核后将 APPROVAL_SHA256 设置为返回的 approval_sha256,并通过同一个绑定到库的计划应用。创建或移除规范页面时,捆绑包中需包含对活跃索引或 MOC 的更新;只有在概览的稳定高层综合内容发生变化时才更新概览:

python3 "$CORE" transaction inspect "$BUNDLE" --vault "$VAULT"
python3 "$CORE" transaction apply "$BUNDLE" --vault "$VAULT" \
  --approved-plan-sha256 "$APPROVAL_SHA256"

绝不要直接写入笔记。

属性

使用扁平 YAML 属性和 YYYY-MM-DD 日期。在 YAML 中为维基链接加引号。

---
type: concept
title: "Contextual Retrieval"
created: 2026-07-11
updated: 2026-07-11
status: developing
tags:
  - retrieval
  - ai/knowledge
aliases:
  - Context-aware retrieval
related:
  - "[[Retrieval]]"
sources:
  - "[[Anthropic Contextual Retrieval]]"
---

生成的维基属性中不要嵌套对象。使用块列表,而不是行内 YAML 数组。即使将纯数字标签作为 YAML 字符串加引号,在 Obsidian 中仍然无效。 使用 year/2026 或 y2026,或将数字存储在 year 属性中。标签至少需要包含一个非数字字符;有效的 Unicode 标签仍受支持。请参阅 Tags,核查日期为 2026-10-17。除非所请求的编辑会更改未知的现有属性,否则予以保留。

维基链接和嵌入

[[Note Name]]
[[Note Name|Display text]]
[[Note Name#Heading]]
[[Note Name#^block-id]]
[[Folder/Note Name]]

This paragraph is addressable. ^evidence-block

![[Note Name#Summary]]
![[diagram.png|480]]
![[paper.pdf#page=3]]

目标文件名必须完全匹配。若文件名存在歧义,请使用相对于库的文件夹路径。外部 URL 使用标准 Markdown 链接;此库中的笔记使用维基链接。

标注块

> [!note]
> Supporting context.

> [!warning] Review required
> This claim has contradictory evidence.

> [!question]- Open question
> What evidence would resolve this?

- 表示默认折叠,+ 表示默认展开。常见的内置类型包括 note、abstract、info、todo、tip、success、question、warning、 failure、danger、bug、example 和 quote。保留库中的 自定义标注块类型,不要重写。

其他 Obsidian 语法

#inline-tag #nested/tag

==Highlighted text==

Visible text %%hidden comment%%

Inline math: $E = mc^2$

$$
\int_0^1 x^2\,dx = \frac{1}{3}
$$

```mermaid
flowchart LR
  Source --> Claim
```

标准 CommonMark/GFM 标题、列表、任务、表格、代码围栏和 脚注仍然有效。原生 Markdown 足以表达时,请避免使用 HTML。

验证起草的笔记

  • 解析 YAML 边界,并保持属性类型一致。
  • 验证所有可在本地检查的内部目标、标题和块引用;绝不要捏造目标来让链接看起来完整。
  • 明确区分证据表述与推断,并保留来源定位信息。
  • 确保代码围栏和标注块引用成对闭合。
  • 执行请求变更后,运行确定性的维基 lint,并报告剩余问题,不要暗中修复。

对于引用来源的页面,还要遵循 provenance.md。应用编辑后,报告事务操作 ID 和确切的变更路径。

评论

支持 Markdown