mcpField
O
obsidian-markdown

obsidian-markdown

github.com/kepano生産性50.3k93.5k 回インストール6 週間前に更新
リポジトリ

obsidian-markdown について

Obsidian Flavored Markdown のノートを作成・編集するスキルです。標準 Markdown に加え、保管庫内リンク、埋め込み、コールアウト、プロパティなど Obsidian 固有の記法を扱います。

主な機能

  1. 01frontmatter プロパティ付きノートの作成
  2. 02wikilinks による保管庫内ノートのリンク
  3. 03ノートやメディアの埋め込み
  4. 04コールアウトと非表示コメントの追加
  5. 05Obsidian タグと書式の利用

活用シーン

  1. 01保管庫内のノートをリンクした文章の作成
  2. 02ノートへの画像や PDF ページの埋め込み
  3. 03コールアウトによる情報の強調

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/kepano/obsidian-skills --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 を拡張し、ウィキリンク、埋め込み、コールアウト、プロパティ、コメントなどの構文を追加しています。このスキルでは Obsidian 固有の拡張機能のみを扱います。標準的な Markdown(見出し、太字、斜体、リスト、引用、コードブロック、テーブル)は既知のものとします。

ワークフロー: Obsidian ノートの作成

  1. フロントマターを追加する: ファイルの先頭にプロパティ(title、tags、aliases)を記述します。すべてのプロパティ型については PROPERTIES.md を参照してください。
  2. コンテンツを書く: 構造には標準的な Markdown を使い、以下に示す Obsidian 固有の構文を併用します。
  3. 関連ノートをリンクする: 保管庫内の接続にはウィキリンク([[Note]])を、外部 URL には標準的な Markdown リンクを使用します。
  4. コンテンツを埋め込む: ![[embed]] 構文を使って、他のノート、画像、PDF のコンテンツを埋め込みます。すべての埋め込み型については EMBEDS.md を参照してください。
  5. コールアウトを追加する: > [!type] 構文を使って、目立たせたい情報にコールアウトを付けます。すべてのコールアウト型については CALLOUTS.md を参照してください。
  6. 確認する: ノートが Obsidian のリーディングビューで正しくレンダリングされることを確認します。

ウィキリンクと Markdown リンクの使い分け: 保管庫内のノートには [[wikilinks]](Obsidian が名前変更を自動的に追跡します)を、外部 URL にのみ [text](url) を使用します。

内部リンク(ウィキリンク)

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

埋め込み

ウィキリンクの先頭に ! を付けると、そのコンテンツをインラインで埋め込めます:

![[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 を参照してください。

プロパティ(フロントマター)

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

タグには英字、数字(先頭文字を除く)、アンダースコア、ハイフン、スラッシュを含めることができます。タグはフロントマターの 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]].

参照

コメント