mcpField
O
obsidian-markdown

obsidian-markdown

github.com/sickn33生産性48.7k78 回インストール1 日前に更新
リポジトリ

obsidian-markdown について

Obsidian Flavored Markdown Skillは、Obsidianで正しく表示されるノートの作成と編集を支援します。ウィキリンク、埋め込み、コールアウト、フロントマターのプロパティなど、Obsidian固有の構文を扱います。

主な機能

  1. 01Obsidian対応Markdownの作成
  2. 02ウィキリンクと埋め込みの使用
  3. 03コールアウトとフロントマターの追加
  4. 04タグ、コメント、ハイライトへの対応
  5. 05図、数式、脚注の記述

活用シーン

  1. 01Obsidianの保管庫でノートを作成
  2. 02保管庫内の関連ノートをリンク
  3. 03ノートへのPDFや画像の埋め込み
  4. 04強調情報や折りたたみ情報の書式設定

インストール

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

$npx skills add https://github.com/sickn33/agentic-awesome-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 向けの Markdown ノートを作成または編集する場合に使用します。
  • ウィキリンク、埋め込み、コールアウト、フロントマタープロパティ、または Obsidian 固有の構文を伴うタスクの場合に使用します。
  • ユーザーが Obsidian 保管庫内で正しくレンダリングされるノートを求める場合に使用します。

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

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

ウィキリンクと Markdown リンクのどちらを選ぶか: 保管庫内のノートには [[wikilinks]] を使用し(Obsidian は名前の変更を自動的に追跡します)、外部 URL にのみ通常の Markdown リンクを使用してください。

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

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

参考資料

制限事項

  • このスキルは、タスクが上記の範囲に明確に一致する場合にのみ使用してください。
  • 出力を、環境固有の検証、テスト、または専門家によるレビューの代わりとして扱わないでください。
  • 必要な入力、権限、安全境界、または成功基準が不足している場合は、停止して明確化を求めてください。

コメント