obsidian-markdown について
obsidian-markdown は、Obsidian の構文に沿った Markdown を作成・編集する Claude Code 向けスキルです。ウィキリンク、埋め込み、コールアウト、YAML プロパティなどを扱います。
主な機能
- 01Obsidian Markdown の作成と編集
- 02ウィキリンクとブロック参照の追加
- 03ノートやメディアの埋め込み
- 04コールアウトと入れ子のコールアウトの作成
- 05YAML プロパティとタグの管理
- 06テーブル、数式、Mermaid 図の利用
活用シーン
- 01Obsidian の保管庫でノートを作成
- 02見出しやブロックへのリンク
- 03画像、音声、PDF の埋め込み
- 04プロパティとタグによるノート整理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ davepoon/ buildwithclaude --skill obsidian-markdownインストール後、Claude Code で/obsidian-markdownを入力して読み込まれたか確認します。
詳細
Obsidian Flavored Markdown
このスキルを使うと、Claude Code でウィキリンク、埋め込み、コールアウト、プロパティ、および関連するすべての構文を含む、有効な Obsidian Flavored Markdown を作成・編集できます。
このスキルを使用する場面
- Obsidian の保管庫で .md ファイルを扱うとき
- ウィキリンクや内部リンクを含むノートを作成するとき
- ノート、画像、音声、PDF を埋め込むとき
- コールアウト(情報ボックス、警告、ヒントなど)を使用するとき
- YAML 形式でフロントマター/プロパティを管理するとき
- タグや階層タグを扱うとき
- ブロック参照やブロック ID を作成するとき
基本的な書式設定
段落と改行
段落は空行で区切ります。段落内の単一の改行は、次のいずれかを使用しない限り無視されます。
- 行末にスペースを 2 つ入れる
- または
<br>を使用して明示的に改行する
見出し
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
テキストのスタイル設定
**Bold text**
*Italic text*
***Bold and italic***
~~Strikethrough~~
==Highlighted text==
内部リンク(ウィキリンク)
基本的なウィキリンク
[[Note Name]]
[[Note Name|Display Text]]
[[Folder/Note Name]]
見出しへのリンク
[[Note Name#Heading]]
[[Note Name#Heading|Display Text]]
[[#Heading in Current Note]]
ブロック参照
[[Note Name#^block-id]]
[[Note Name#^block-id|Display Text]]
[[#^block-id]]
ブロック ID の作成
段落またはリスト項目の末尾にブロック ID を追加します。
This is a paragraph you can reference. ^my-block-id
- List item with ID ^list-block
埋め込み
ノートの埋め込み
![[Note Name]]
![[Note Name#Heading]]
![[Note Name#^block-id]]
画像の埋め込み
![[image.png]]
![[image.png|400]]
![[image.png|400x300]]
音声の埋め込み
![[audio.mp3]]
PDF の埋め込み
![[document.pdf]]
![[document.pdf#page=5]]
![[document.pdf#height=400]]
動画の埋め込み
![[video.mp4]]
コールアウト
基本的なコールアウト構文
> [!note]
> This is a note callout.
> [!warning]
> This is a warning callout.
> [!tip] Custom Title
> This callout has a custom title.
コールアウトの種類
| 種類 | 別名 | 説明 |
|---|---|---|
note | デフォルトの青い情報ボックス | |
abstract | summary, tldr | 要約 |
info | 情報 | |
todo | タスク/やること項目 | |
tip | hint, important | 役立つヒント |
success | check, done | 成功メッセージ |
question | help, faq | 質問/FAQ |
warning | caution, attention | 警告メッセージ |
failure | fail, missing | 失敗メッセージ |
danger | error | エラー/危険 |
bug | バグ報告 | |
example | 使用例 | |
quote | cite | 引用 |
折りたたみ可能なコールアウト
> [!note]+ Expanded by default
> Content visible initially.
> [!note]- Collapsed by default
> Content hidden initially.
入れ子になったコールアウト
> [!question] Can callouts be nested?
> > [!answer] Yes!
> > Callouts can be nested inside each other.
リスト
順序なしリスト
- Item 1
- Item 2
- Nested item
- Another nested item
- Item 3
順序付きリスト
1. First item
2. Second item
1. Nested numbered item
3. Third item
タスクリスト
- [ ] Uncompleted task
- [x] Completed task
- [ ] Another task
コードブロック
インラインコード
Use `inline code` for short snippets.
フェンス付きコードブロック
```javascript
function hello() {
console.log("Hello, world!");
}
```
対応言語
Obsidian は、javascript、typescript、python、rust、go、java、c、cpp、csharp、ruby、php、html、css、json、yaml、markdown、bash、sql など、多くの言語の構文ハイライトに対応しています。
テーブル
| Header 1 | Header 2 | Header 3 |
|----------|:--------:|---------:|
| Left | Center | Right |
| aligned | aligned | aligned |
数式(LaTeX)
インライン数式
The equation $E = mc^2$ is famous.
ブロック数式
$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$
図(Mermaid)
```mermaid
graph TD
A[Start] --> B{Decision}
B -->|Yes| C[Do Something]
B -->|No| D[Do Something Else]
C --> E[End]
D --> E
```
脚注
This is a sentence with a footnote.[^1]
[^1]: This is the footnote content.
コメント
%%
This is a comment that won't be rendered.
%%
Inline %%comment%% within text.
プロパティ(フロントマター)
基本的なプロパティ
---
title: My Note Title
date: 2024-01-15
tags:
- tag1
- tag2
author: John Doe
---
プロパティの種類
| 種類 | 例 |
|---|---|
| テキスト | title: My Title |
| 数値 | rating: 5 |
| チェックボックス | completed: true |
| 日付 | date: 2024-01-15 |
| 日時 | created: 2024-01-15T10:30:00 |
| リスト | tags: [a, b, c] または複数行 |
| リンク | related: "[[Other Note]]" |
複数値プロパティ
---
tags:
- project
- work
- important
aliases:
- My Alias
- Another Name
cssclasses:
- wide-page
- cards
---
タグ
インラインタグ
This note is about #productivity and #tools.
階層タグ
#project/work
#status/in-progress
#priority/high
フロントマター内のタグ
---
tags:
- project
- project/work
- status/active
---
HTML サポート
Obsidian は HTML の一部に対応しています。
<div class="my-class">
Custom HTML content
</div>
<details>
<summary>Click to expand</summary>
Hidden content here
</details>
<kbd>Ctrl</kbd> + <kbd>C</kbd>
完全な例
---
title: Project Alpha Overview
date: 2024-01-15
tags:
- project
- documentation
status: active
---
# Project Alpha Overview
## Summary
This document outlines the key aspects of **Project Alpha**. For related materials, see [[Project Alpha/Resources]] and [[Team Members]].
> [!info] Quick Facts
> - Start Date: January 2024
> - Team Size: 5 members
> - Status: Active
## Key Features
1. [[Feature A]] - Core functionality
2. [[Feature B]] - User interface
3. [[Feature C]] - API integration
### Feature A Details
The main equation governing our approach is $f(x) = ax^2 + bx + c$.
![[feature-a-diagram.png|500]]
> [!tip] Implementation Note
> See [[Technical Specs#^impl-note]] for implementation details.
## Tasks
- [x] Initial planning ^planning-task
- [ ] Development phase
- [ ] Testing phase
- [ ] Deployment
## Code Example
```python
def process_data(input):
return transform(input)
アーキテクチャ
graph LR
A[Input] --> B[Process]
B --> C[Output]
メモ
この方法は==最近の研究==1に着想を得ています。
%% TODO: Add more examples Review with team next week %%
#project/alpha #documentation
## References
- [Obsidian Formatting Syntax](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax)
- [Advanced Formatting](https://help.obsidian.md/Editing+and+formatting/Advanced+formatting+syntax)
- [Internal Links](https://help.obsidian.md/Linking+notes+and+files/Internal+links)
- [Embedding Files](https://help.obsidian.md/Linking+notes+and+files/Embed+files)
- [Callouts](https://help.obsidian.md/Editing+and+formatting/Callouts)
- [Properties](https://help.obsidian.md/Editing+and+formatting/Properties)
Footnotes
-
Smith, J. (2024). Modern Approaches to Data Processing. ↩
コメント
Markdown 対応