💽

Obsidianプラグイン開発の初め方(サンプルプラグインのクローンとビルド)

に公開

公式からサンプルプラグインをクローンする

Obsidian公式が提供しているサンプルプラグイン obsidianmd/obsidian-sample-plugin
Obsidianのプラグインフォルダ(.obsidian/plugins)でターミナルを開きクローン作成。

git clone https://github.com/obsidianmd/obsidian-sample-plugin.git "/path/to/your/vault/.obsidian/plugins/my-new-plugin"

ビルドする

すでにObsidianの設定画面 Community Plugins にプラグインが表示されるはず。

ただし現時点ではmain.jsが出来ていないため動かない。
ビルドによってTypeScriptで書かれたソースコードを、Obsidianが読み込めるJavaScriptのファイル(main.js)に変換する。

# プラグインのディレクトリに移動
cd "/path/to/your/vault/.obsidian/plugins/my-new-plugin"

# 必要なライブラリをインストール
npm install

# ビルドを実行
npm run build

main.js が生成され、Obsidianでプラグインが読み込めるようになる。

以降、コーディングはmain.tsをベースに進めていくことになる。

Discussion